Status Callbacks

Overview

Status Callbacks allow you to receive events related to the REST resources managed by Twilio: Rooms, Recordings and Compositions.

All HTTP requests set the "Content-Type" header to “application/x-www-form-urlencoded”.

Contents

• Room Status Callbacks
  • Room Status Callback Events
  • Rooms Status Callback request parameters
  • Recordings Status Callback request parameters
• Compositions Status Callbacks
  • Compositions Status Callback Events
  • Compositions Status Callback request parameters

Rooms Status Callbacks

Rooms Status Callbacks allow you to receive events related to your Rooms via HTTP request. Configure a StatusCallback URL when creating a Room using the REST API, and Twilio will make an HTTP request (webhook) to that URL whenever an event takes place in the Room.

The Rooms API will generate the following Status Callback events.

Rooms Status Callback Events

The following events are dispatched to webhook URL specified at Room creation.

Example

A curl example of configuring the StatusCallback URL.

 curl -XPOST 'https://video.twilio.com/v1/Rooms' \
 -u '{API Key SID}:{API Secret}' \
 -d 'UniqueName=DailyStandup' \
 -d 'StatusCallback=https://hooks.yoursite.com/room-events' \
 -d 'StatusCallbackMethod=POST' \
 -d 'Type=peer-to-peer'

Rooms Status Callback request parameters

Twilio passes the following parameters in each of the above-listed events whenever it makes an HTTP request to the StatusCallback URL you've set:

Recordings Status Callback request parameters

The parameters below are included only in events related to Recordings.

Compositions Status Callbacks

Composition Status Callbacks allow you to receive events related to your Compositions via HTTP request. You can configure the StatusCallback URL to receive your callbacks using two mechanisms:

• When you create a Composition using directly the REST API, you can set the StatusCallback URL as a POST parameter. In this case, at that URL you will only receive events related to that specific Composition.
• When you create a Composition Hook, you can set the StatusCallback URL at such Hook. In this case, at that URL you will receive events regarding that Hook as well as events regarding all Compositions created by such Hook.

Twilio will generate the following Status Callback events regarding your Compositions and Composition Hooks.

Compositions Status Callback Events

The following events are dispatched to Compositions and Composition Hooks StatusCallback URLs.

Compositions Status Callback request parameters

The parameters below are included in the composition-* events.