/v1/Subscriptions/{Sid}

Delete a specific Subscription.

• Sid (path, required) — A 34 character string that uniquely identifies this Subscription.

/v1/Subscriptions/{Sid}

Fetch a specific Subscription.

• Sid (path, required) — A 34 character string that uniquely identifies this Subscription.

/v1/Sinks/{Sid}

Update a specific Sink

• Sid (path, required) — A 34 character string that uniquely identifies this Sink.

/v1/Sinks/{Sid}/Test

Create a new Sink Test Event for the given Sink.

• Sid (path, required) — A 34 character string that uniquely identifies the Sink to be Tested.

/v1/Sinks/{Sid}/Validate

Validate that a test event for a Sink was received.

• Sid (path, required) — A 34 character string that uniquely identifies the Sink being validated.

/v1/Subscriptions

Retrieve a paginated list of Subscriptions belonging to the account used to make the request.

• SinkSid (query) — The SID of the sink that the list of Subscriptions should be filtered by.
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Subscriptions

Create a new Subscription.

/v1/Schemas/{Id}

Fetch a specific schema with its nested versions.

• Id (path, required) — The unique identifier of the schema. Each schema can have multiple versions, that share the same id.

/v1/Schemas/{Id}/Versions

Retrieve a paginated list of versions of the schema.

• Id (path, required) — The unique identifier of the schema. Each schema can have multiple versions, that share the same id.
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Schemas/{Id}/Versions/{SchemaVersion}

Fetch a specific schema and version.

• Id (path, required) — The unique identifier of the schema. Each schema can have multiple versions, that share the same id.
• SchemaVersion (path, required) — The version of the schema

/v1/Sinks

Retrieve a paginated list of Sinks belonging to the account used to make the request.

• InUse (query) — A boolean query parameter filtering the results to return sinks used/not used by a subscription.
• Status (query) — A String query parameter filtering the results by status `initialized`, `validating`, `active` or `failed`.
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Sinks

Create a new Sink

/v1/Sinks/{Sid}

Delete a specific Sink.

• Sid (path, required) — A 34 character string that uniquely identifies this Sink.

/v1/Sinks/{Sid}

Fetch a specific Sink.

• Sid (path, required) — A 34 character string that uniquely identifies this Sink.

/v1/Subscriptions/{Sid}

Update a Subscription.

• Sid (path, required) — A 34 character string that uniquely identifies this Subscription.

/v1/Subscriptions/{SubscriptionSid}/SubscribedEvents

Retrieve a list of all Subscribed Event types for a Subscription.

• SubscriptionSid (path, required) — The unique SID identifier of the Subscription.
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Subscriptions/{SubscriptionSid}/SubscribedEvents

Create a new Subscribed Event type for the subscription

• SubscriptionSid (path, required) — The unique SID identifier of the Subscription.

/v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type}

Remove an event type from a subscription.

• SubscriptionSid (path, required) — The unique SID identifier of the Subscription.
• Type (path, required) — Type of event being subscribed to.

/v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type}

Read an Event for a Subscription.

• SubscriptionSid (path, required) — The unique SID identifier of the Subscription.
• Type (path, required) — Type of event being subscribed to.

/v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type}

Update an Event for a Subscription.

• SubscriptionSid (path, required) — The unique SID identifier of the Subscription.
• Type (path, required) — Type of event being subscribed to.

/v1/Types

Retrieve a paginated list of all the available Event Types.

• SchemaId (query) — A string parameter filtering the results to return only the Event Types using a given schema.
• PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
• Page (query, page) — The page index. This value is simply for client state.
• PageToken (query) — The page token. This is provided by the API.

/v1/Types/{Type}

Fetch a specific Event Type.

• Type (path, required) — A string that uniquely identifies this Event Type.