Twilio

Twilio Webhooks v1

Centralized webhook configuration with OAuth2 support, immutable resources, and zero-downtime credential rotation.

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

Centralized webhook configuration with OAuth2 support, immutable resources, and zero-downtime credential rotation.

Endpoints 24

SharedKeys

  • GETList all SharedKeys/v1/Webhooks/SharedKeys?pageSize=20&pageToken=stringReturns paginated list of SharedKey summaries (secrets never included)
  • POSTCreate a new SharedKey/v1/Webhooks/SharedKeysCreates a new Shared Key for webhook signature validation. IMPORTANT: The secret field is ONLY returned in this response and cannot be retrieved later. Store…
  • GETGet a SharedKey by ID/v1/Webhooks/SharedKeys/:sharedKeyIdReturns a SharedKey by its ID. The secret is never included in GET responses.
  • DELETEDelete SharedKey (hard delete)/v1/Webhooks/SharedKeys/:sharedKeyIdPermanently deletes a Shared Key. The API prevents deletion if any Settings reference this key. Delete the dependent Settings first, then delete the SharedKey.
  • PATCHUpdate SharedKey friendlyName/v1/Webhooks/SharedKeys/:sharedKeyIdUpdate SharedKey's friendlyName only. SharedKeys are otherwise immutable.

AuthProfiles

  • GETList all AuthProfile resources/v1/Webhooks/AuthProfiles?pageSize=20&pageToken=stringReturns a paginated list of AuthProfile summaries. Secrets are never included in list responses.
  • POSTCreate a new AuthProfile resource/v1/Webhooks/AuthProfilesCreates a new reusable AuthProfile resource for use across multiple Settings.
  • GETGet AuthProfile by ID/v1/Webhooks/AuthProfiles/:authProfileIdReturns an AuthProfile resource by its ID. Secrets are never returned in GET responses.
  • DELETEDelete AuthProfile (hard delete)/v1/Webhooks/AuthProfiles/:authProfileIdPermanently deletes the AuthProfile resource. Returns 409 Conflict if the AuthProfile is still referenced by any Settings resource. 409 Resolution: 1. List…
  • PATCHUpdate AuthProfile friendlyName/v1/Webhooks/AuthProfiles/:authProfileIdUpdates only the friendlyName field. AuthProfile resources are immutable except for friendlyName. To change auth configuration (clientId, tokenUrl, etc.),…

Settings

  • GETList all Settings/v1/Webhooks/Settings?pageSize=20&pageToken=string&authProfileId=string&sharedKeyId=string&type=CUSTOMERReturns a paginated list of Setting summaries. Use query parameters to filter by authProfileId or sharedKeyId, or to list Twilio-managed system Settings…
  • POSTCreate a new Setting/v1/Webhooks/SettingsCreates an immutable webhook configuration. Authentication: Inline vs Shared Inline (Recommended): Credentials directly in Setting (source: INLINE) Use when:…
  • GETGet Setting by ID/v1/Webhooks/Settings/:settingIdReturns a Setting by its ID, including full auth, signature, connection, and edge configuration.
  • DELETEDelete Setting (hard delete)/v1/Webhooks/Settings/:settingIdPermanently deletes the Setting resource. Returns 409 Conflict if the Setting is still referenced by any Rule or if it's a system-created Setting. 409…
  • PATCHUpdate Setting friendlyName and description/v1/Webhooks/Settings/:settingIdUpdates only the friendlyName and/or description fields. Settings are immutable except for these fields. To change configuration (auth, signature, connection,…

Rules

  • GETList all Rules/v1/Webhooks/Rules?pageSize=20&pageToken=string&settingId=stringReturns paginated list of Rules sorted by evaluation order: 1. exact-match rules (evaluated first, longest match first) 2. prefix-match rules (longest prefix…
  • POSTCreate a new Rule (async)/v1/Webhooks/RulesCreates a URL matching rule. Returns immediately after validation, then propagates globally. How It Works Immediate: Request validated → 202 Accepted (with…
  • GETGet a Rule by ID/v1/Webhooks/Rules/:ruleIdReturns a Rule by its ID, including matchType, match value, and current traffic distribution settings.
  • DELETEDelete Rule (hard delete, async)/v1/Webhooks/Rules/:ruleIdPermanently deletes a Rule. Returns 202 Accepted; the deletion propagates globally in 30-60 seconds. Poll the returned Operation-Id for completion.
  • PATCHUpdate Rule (async)/v1/Webhooks/Rules/:ruleIdUpdates rule configuration. Returns 202 Accepted, propagates in 30-60 seconds. Gradual Rollout Pattern Test configuration changes with production traffic…

Operations

  • GETList all Operations/v1/Webhooks/Operations?pageSize=20&pageToken=string&status=PENDING&resourceId=stringReturns a paginated list of async Rule operations. Use this endpoint to recover a lost Operation-Id — for example, after a process crash before the ID was…
  • GETGet Operation status/v1/Webhooks/Operations/:operationIdCheck status of an async Rule operation. Operation Lifecycle Operations transition from PENDING to COMPLETED status within 30-60 seconds of a Rule mutation…

Tests

  • POSTTest webhook delivery/v1/Webhooks/TestsSend a test webhook to validate your configuration. Requires a settingId — tests end-to-end delivery using the specified Setting's auth, signature, and…

EdgeZones

  • GETList available edge zones/v1/Webhooks/EdgeZones?pageSize=20&pageToken=stringReturns the edge zone catalog for webhook delivery. Supports pagination via pageSize and pageToken (see Pagination). Read-only discovery endpoint - use this…

API details

Base URL
https://webhooks.twilio.com
Authentication
HTTP Basic authentication (username and password)
Operations
24 operations on 12 pathsGET 11POST 5PATCH 4DELETE 4
Main resources
AuthProfiles 5Rules 5Settings 5SharedKeys 5Operations 2EdgeZones 1Tests 1
Response formats
application/json application/problem+json
Description format
OpenAPI 3.0.3, API version 1.0.0

How to test the Twilio Webhooks 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 Webhooks 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 “List all SharedKeys” (GET /v1/Webhooks/SharedKeys?pageSize=20&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 Webhooks v1?

Centralized webhook configuration with OAuth2 support, immutable resources, and zero-downtime credential rotation. It is listed under Communication and has 24 endpoints.

Who publishes the Twilio Webhooks 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 Webhooks v1?

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

How do I authenticate with the Twilio Webhooks v1?

With HTTP Basic authentication (username and password).

How many endpoints does the Twilio Webhooks v1 have?

24 operations on 12 paths (11 GET, 5 POST, 4 PATCH, 4 DELETE). The largest groups are AuthProfiles, Rules, Settings, SharedKeys.

Is forking the Twilio Webhooks 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.