Returns a single CompositionHook resource identified by a CompositionHook SID.

get/v1/CompositionHooks/{Sid}

Path parameters

Sidstring required

The SID of the CompositionHook resource to fetch.

Response

account_sidstring nullable

The SID of the Account that created the CompositionHook resource.

friendly_namestring nullable

The string that you assigned to describe the resource. Can be up to 100 characters long and must be unique within the account.

enabledboolean nullable

Whether the CompositionHook is active. When true, the CompositionHook is triggered for every completed Group Room on the account. When false, the CompositionHook is never triggered.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

sidstring nullable

The unique string that we created to identify the CompositionHook resource.

audio_sourcesstring[] nullable

The array of track names to include in the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in audio_sources except those specified in audio_sources_excluded. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, student* includes tracks named student as well as studentTeam. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request

audio_sources_excludedstring[] nullable

The array of track names to exclude from the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in audio_sources except for those specified in audio_sources_excluded. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, student* excludes student as well as studentTeam. This parameter can also be empty.

{"stackTrail":"components:schemas:video.v1.composition_hook:properties:video_layout","oasType":"schema","type":"unknown","description":"A JSON object that describes the video layout of the composition in terms of regions as specified in the HTTP POST request that created the CompositionHook resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request","extensionFields":{"x-twilio":{"pii":{"handling":"standard","deleteSla":30}}},"nullable":true}

resolutionstring nullable

The dimensions of the video image in pixels expressed as columns (width) and rows (height). The string's format is {width}x{height}, such as 640x480.

trimboolean nullable

Whether intervals with no media are clipped, as specified in the POST request that created the CompositionHook resource. Compositions with trim enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See Specifying Video Layouts for more info.

format'mp4' | 'webm'

The container format of the media files used by the compositions created by the composition hook. If mp4 or webm, audio_sources must have one or more tracks and/or a video_layout element must contain a valid video_sources list, otherwise an error occurs.

status_callbackstring uri nullable

The URL we call using the status_callback_method to send status information to your application.

status_callback_method'GET' | 'POST' http-method nullable

The HTTP method we should use to call status_callback. Can be POST or GET and defaults to POST.

urlstring uri nullable

The absolute URL of the resource.

Changes

Changed in 4 of the 50 revisions of this API.25

Aug 18, 2025v1207f8ef612391See the full diff
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
Mar 11, 2025v1ad992ed01a681See the full diff
- ▲
  the response's property type changed from no type to object for status
  response-property-type-changed
Apr 18, 2024v1d68da44b72424See the full diff
- ○
  removed the DELETE enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the HEAD enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PATCH enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PUT enum value from the response property for the response status
  response-property-enum-value-removed
Aug 10, 2023v1987a2e6965981See the full diff
- ○
  api tag VideoV1CompositionHook added
  api-tag-added

Full history