Webhooks

Unsubscribe from Webhook

DELETE
/v1/Webhooks/{Type}

Disables webhooks for a particular Event Type

AuthorizationBasic <token>

Basic Authorization header using the BASIC scheme. Use a pair companySid:token to access the API.

In: header

Path Parameters

Type*string

Specifies the type of the webhook.

Value in

  • "TcrCampaignImported"
  • "PhoneNumberStatusChanged"
  • "PhoneNumberVoiceStatusChanged"
  • "TrafficLimitAlert"
  • "InboundCallReceived"
  • "InboundCallReceivedFallback"
  • "CallStatusChanged"
  • "CallRecordingCompleted"
  • "RcsOutboundMessageStatusChanged"
  • "RcsInboundMessageReceived"
  • "RcsInboundUserAction"
  • "RcsMessageSeen"
  • "RcsTypingIndicator"

Response Body

curl -X DELETE "https://example.com/v1/Webhooks/TcrCampaignImported"
{  "wasRemoved": false}
{  "errors": {    "Name": [      "The Name field is required."    ]  },  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",  "title": "One or more validation errors occurred.",  "status": 400,  "detail": "Some detailed message",  "traceId": "|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}