Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Build

Builds are packages of Functions and Assets that you bundle together for deployment. Builds contain Function Version SIDs, Asset Version SIDs, and dependencies. Dependencies are Node.js packages from NPM.

Dependencies are defined as JSON strings, for example:

let dependencies = `[{"name": "randomcolor","version":"0.5.4" },
 {"name": "util","version":"0.10.3" },
 {"name": "xmldom","version":"0.1.27" },
 {"name": "got","version":"6.7.1" },
 {"name": "fs","version":"0.0.1-security" },
 {"name": "lodash","version":"4.17.11" },
 {"name": "date-fns","version":"1.30.1" }]`

Builds take time to package, deploy and be verified. After creating a build, it is best to poll every 1 second to check the build status. When a build is verified, it is ready to be used in a Deployment.

List of build statuses

Build Status

Meaning

Queued A build request has been queued to be picked and deployed.
Building Build request being processed by the packager.
Deploying New package is being uploaded.
Deployed Package successfully deployed.
Verified We have run a health check on the uploaded package and verified it.
Failed Packaging has failed at any of the above step.

Build properties

Names in PHP format
sid
sid<ZB> Not PII

The unique SID identifier of this Build.

accountSid
sid<AC> Not PII

The unique SID identifier of the Account that owns this Build.

serviceSid
sid<ZS> Not PII

The unique SID identifier of the Service for this Build.

status
enum:status Not PII

The current state of the Build. One of building, completed, or failed.

assetVersions
object[] Not PII

The list of Asset Version Sids that are included in this Build.

functionVersions
object[] Not PII

The list of Function Version Sids that are included in this Build.

dependencies
object[] Not PII

The list of Dependencies that are included in this Build, each described by a name and a version in a JSON object.

dateCreated
date_time<iso8601> Not PII

The date that this Build was created, given in ISO 8601 format.

dateUpdated
date_time<iso8601> Not PII

The date that this Build was updated, given in ISO 8601 format.

url
url Not PII

The URL of this Build.

Create a Build resource

post
https://serverless.twilio.com/v1/Services/{ServiceSid}/Builds
Parameters
Names in None format
service_sid
Required
post sid_like<ZS> Not PII

The unique SID identifier of the Service for this Build.

asset_versions
Optional
post sid<ZN>[] Not PII

The list of Asset Version Sids that are included in this Build. Optional.

function_versions
Optional
post sid<ZN>[] Not PII

The list of Function Version Sids that are included in this Build. Optional.

dependencies
Optional
post string Not PII

The list of Dependencies that are included in this Build, each described by a name and a version in a JSON object. Optional.

Example
        
        
        
        

        Fetch a Build resource

        get
        https://serverless.twilio.com/v1/Services/{ServiceSid}/Builds/{Sid}
        Parameters
        Names in None format
        service_sid
        Required
        get sid_like<ZS> Not PII

        The unique SID identifier of the Service for this Build.

        sid
        Required
        get sid<ZB> Not PII

        The unique SID identifier of this Build.

        Example
              
              
              
              

              Read multiple Build resources

              get
              https://serverless.twilio.com/v1/Services/{ServiceSid}/Builds
              Parameters
              Names in None format
              service_sid
              Required
              get sid_like<ZS> Not PII

              The unique SID identifier of the Service for these Builds.

              Example
                    
                    
                    
                    

                    Delete a Build resource

                    delete
                    https://serverless.twilio.com/v1/Services/{ServiceSid}/Builds/{Sid}
                    Parameters
                    Names in None format
                    service_sid
                    Required
                    delete sid_like<ZS> Not PII

                    The unique SID identifier of the Service for the Build.

                    sid
                    Required
                    delete sid<ZB> Not PII

                    The unique SID identifier of this Build.

                    Example
                          
                          
                          
                          
                          Rate this page:

                          Need some help?

                          We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.