Twilio

Twilio Events v1

This is the public Twilio REST API.

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the public Twilio REST API.

Endpoints 22

EventsV1EventType

  • GETRetrieve a paginated list of all the available Event Types./v1/Types?SchemaId=Messaging.MessageStatus&PageSize=1&Page=0&PageToken=stringRetrieve a paginated list of all the available Event Types.
  • GETFetch a specific Event Type./v1/Types/:TypeFetch a specific Event Type.

EventsV1Schema

  • GETFetch a specific schema with its nested versions./v1/Schemas/:IdFetch a specific schema with its nested versions.

EventsV1SchemaVersion

  • GETRetrieve a paginated list of versions of the schema./v1/Schemas/:Id/Versions?PageSize=1&Page=0&PageToken=stringRetrieve a paginated list of versions of the schema.
  • GETFetch a specific schema and version./v1/Schemas/:Id/Versions/:SchemaVersionFetch a specific schema and version.

EventsV1Sink

  • GETFetch a specific Sink./v1/Sinks/:SidFetch a specific Sink.
  • POSTUpdate a specific Sink/v1/Sinks/:SidUpdate a specific Sink
  • DELETEDelete a specific Sink./v1/Sinks/:SidDelete a specific Sink.
  • GETRetrieve a paginated list of Sinks belonging to the account used to make the request./v1/Sinks?InUse=true&Status=active&PageSize=1&Page=0&PageToken=stringRetrieve a paginated list of Sinks belonging to the account used to make the request.
  • POSTCreate a new Sink/v1/SinksCreate a new Sink

EventsV1SinkTest

  • POSTCreate a new Sink Test Event for the given Sink./v1/Sinks/:Sid/TestCreate a new Sink Test Event for the given Sink.

EventsV1SinkValidate

  • POSTValidate that a test event for a Sink was received./v1/Sinks/:Sid/ValidateValidate that a test event for a Sink was received.

EventsV1SubscribedEvent

  • GETRetrieve a list of all Subscribed Event types for a Subscription./v1/Subscriptions/:SubscriptionSid/SubscribedEvents?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Subscribed Event types for a Subscription.
  • POSTAdd an event type to a Subscription./v1/Subscriptions/:SubscriptionSid/SubscribedEventsAdd an event type to a Subscription.
  • GETRead an Event for a Subscription./v1/Subscriptions/:SubscriptionSid/SubscribedEvents/:TypeRead an Event for a Subscription.
  • POSTUpdate an Event for a Subscription./v1/Subscriptions/:SubscriptionSid/SubscribedEvents/:TypeUpdate an Event for a Subscription.
  • DELETERemove an event type from a Subscription./v1/Subscriptions/:SubscriptionSid/SubscribedEvents/:TypeRemove an event type from a Subscription.

EventsV1Subscription

  • GETRetrieve a paginated list of Subscriptions belonging to the account used to make the request./v1/Subscriptions?SinkSid=DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=1&Page=0&PageToken=stringRetrieve a paginated list of Subscriptions belonging to the account used to make the request.
  • POSTCreate a new Subscription./v1/SubscriptionsCreate a new Subscription.
  • GETFetch a specific Subscription./v1/Subscriptions/:SidFetch a specific Subscription.
  • POSTUpdate a Subscription./v1/Subscriptions/:SidUpdate a Subscription.
  • DELETEDelete a specific Subscription./v1/Subscriptions/:SidDelete a specific Subscription.

API details

Base URL
https://events.twilio.com
Authentication
HTTP Basic authentication (username and password)
Operations
22 operations on 13 pathsGET 11POST 8DELETE 3
Main resources
EventsV1Sink 5EventsV1SubscribedEvent 5EventsV1Subscription 5EventsV1EventType 2EventsV1SchemaVersion 2EventsV1Schema 1EventsV1SinkTest 1EventsV1SinkValidate 1
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 1.0.0

How to test the Twilio Events v1 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio Events v1 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieve a paginated list of all the available Event Types.” (GET /v1/Types?SchemaId=Messaging.MessageStatus&PageSize=1&Page=0&PageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Twilio Events v1?

This is the public Twilio REST API. It is listed under Communication and has 22 endpoints.

Who publishes the Twilio Events v1?

It is listed from Twilio's public API description (an OpenAPI document), not published by Twilio on Swastik Codes. Anyone who controls twilio.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Twilio Events v1?

Requests go to https://events.twilio.com. Endpoint paths are added to this base URL.

How do I authenticate with the Twilio Events v1?

With HTTP Basic authentication (username and password).

How many endpoints does the Twilio Events v1 have?

22 operations on 13 paths (11 GET, 8 POST, 3 DELETE). The largest groups are EventsV1Sink, EventsV1SubscribedEvent, EventsV1Subscription, EventsV1EventType.

Is forking the Twilio Events v1 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.