Webhooks

Opt-In/Out

POST
/v1/Webhooks/OptInOutWebhook

OptInOutWebhook is sent to the MessagingConfig.OptInOutCallbackUrl when an Opt-In/Out is received from the recipient TN.

Authorization

basic
AuthorizationBasic <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/v1/Webhooks/OptInOutWebhook" \  -H "Content-Type: application/json" \  -d '{    "WebhookSid": "WH08dba8f78b5eabd733eba3812a614e8e8257628ef32c888b",    "WebhookType": "OptIn",    "Number": "+19876543210",    "ScopeType": "SenderPhoneNumber",    "Scope": "+11234567890",    "EventDate": "2023-09-09T15:00:00.000Z"  }'
Empty

RCS User Action POST

`RcsInboundUserActionWebhook` is sent to the account-level URL configured for the `RcsInboundUserAction` type when a user has acted over a suggestion sent with an RCS outbound message.

TCR Campaign POST

`TcrCampaignImportedWebhook` is sent to the URL set up with the `/webhooks` endpoint for webhook type `TcrCampaignImported` when a TCR campaign (which you shared with Telgorithm) is imported.