Skip to content
Provisioning API/
/Webhooks

Provisioning API (1.2.7)

Download OpenAPI description
provisioning-api.json
provisioning-api.yaml
Languages
Servers
Production server

https://provisioning.api.sinch.com/

Webhooks

Webhooks allow the Sinch servers to communicate with your server backend. The webhooks endpoint lets you create, update, and delete webhooks programmatically.

Operations

List all webhooks in projectGA

Request

Returns a paginated list of webhooks for the specified project. If no page token is supplied then all registered webhooks (of maximum 15) are returned in alphabetical order.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

The unique ID of the project. You can find this on the Sinch Dashboard.

Query
pageTokenstring

The page token if retrieving the next page from a previous query.

pageSizenumber[ 1 .. 15 ]

The page size requested.

curl -i -X GET \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/webhooks?pageToken=string&pageSize=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of webhooks

Bodyapplication/json
totalSizenumberrequired

Total size of the entries matching the search query.

pageSizenumberrequired

Requested size of the page.

webhooksArray of objects(WebhookWebhookDto)required
webhooks[].​idstringrequired

The ID of the webhook.

webhooks[].​targetstringrequired

The target url where events will be sent to.

webhooks[].​projectIdstringrequired

The project that this webhook belongs to.

webhooks[].​triggersArray of strings(WebhookWebhookTriggers)uniquerequired

List of triggers this webhook is triggered by.

Items Enum"ALL""BUNDLE_DONE""KAKAOTALK_SENDER_ACTIVE""KAKAOTALK_SENDER_COMMENT_ADDED""KAKAOTALK_SENDER_INACTIVE""KAKAOTALK_SENDER_REJECTED""KAKAOTALK_TEMPLATE_APPROVED""KAKAOTALK_TEMPLATE_COMMENT_ADDED""KAKAOTALK_TEMPLATE_REJECTED""RCS_SENDER_COMMENT_ADDED"
previousPageTokenstring

Encoded token to use in list request to fetch previous batch of entries.

nextPageTokenstring

Encoded token to use in list request to fetch next batch of entries.

Response
application/json

Returns a paginated list of webhooks for the specified project. If no page token is supplied then all registered webhooks (of maximum 15) are returned in alphabetical order.

{
  "previousPageToken": "{{TOKEN}}",
  "nextPageToken": "{{TOKEN}}",
  "pageSize": 1,
  "totalSize": 5,
  "webhooks": [
    { … },
    { … }
  ]
}

Register a webhook for projectGA

Request

Register a new webhook for a project. The webhook will be used to communicate updates to resources. Maximum of 15 webhooks allowed per project.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

The unique ID of the project. You can find this on the Sinch Dashboard.

Bodyapplication/jsonrequired

Webhook to register

targetstring(url)[ 1 .. 742 ] charactersrequired

A valid target url where events should be sent to.

secretstring[ 1 .. 128 ] charactersrequired

Secret to be used to sign contents of webhooks sent by the provisioning API. You can then use the secret to verify the signature. Please not that secret should have a high entropy to be considered secure.

triggersArray of strings(WebhookWebhookTriggers)non-emptyuniquerequired

List of triggers you want to be notified about on your webhook. To be able to listen to all type of events use ALL.

  • Common: ALL
  • Bundles: BUNDLE_DONE
  • WhatsApp Sender: WHATSAPP_SENDER_ACTIVE, WHATSAPP_SENDER_COMMENT_ADDED, WHATSAPP_SENDER_DAILY_LIMIT_CHANGED, WHATSAPP_SENDER_ERROR, WHATSAPP_SENDER_INACTIVE, WHATSAPP_SENDER_PENDING_VERIFICATION, WHATSAPP_SENDER_QUALITY_RATING_CHANGED or WHATSAPP_SENDER_REJECTED
  • WhatsApp Template: WHATSAPP_TEMPLATE_APPROVED, WHATSAPP_TEMPLATE_CATEGORY_FUTURE_UPDATE, WHATSAPP_TEMPLATE_CATEGORY_UPDATED, WHATSAPP_TEMPLATE_COMMENT_ADDED, WHATSAPP_TEMPLATE_DELETED, WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED, WHATSAPP_TEMPLATE_REJECTED or WHATSAPP_TEMPLATE_STATUS_UPDATED
  • WhatsApp Account: WHATSAPP_ACCOUNT_COMMENT_ADDED, WHATSAPP_ACCOUNT_ONBOARDED, WHATSAPP_ACCOUNT_PENDING_VERIFICATION, WHATSAPP_ACCOUNT_REJECTED or WHATSAPP_WABA_ACCOUNT_CHANGED
  • RCS Sender: RCS_SENDER_COMMENT_ADDED, RCS_SENDER_OPERATOR_STATUS_UPDATED or RCS_SENDER_STATUS_UPDATED
  • KakaoTalk Sender: KAKAOTALK_SENDER_ACTIVE, KAKAOTALK_SENDER_COMMENT_ADDED, KAKAOTALK_SENDER_INACTIVE or KAKAOTALK_SENDER_REJECTED
  • KakaoTalk Template: KAKAOTALK_TEMPLATE_APPROVED, KAKAOTALK_TEMPLATE_COMMENT_ADDED or KAKAOTALK_TEMPLATE_REJECTED
Items Enum"ALL""BUNDLE_DONE""KAKAOTALK_SENDER_ACTIVE""KAKAOTALK_SENDER_COMMENT_ADDED""KAKAOTALK_SENDER_INACTIVE""KAKAOTALK_SENDER_REJECTED""KAKAOTALK_TEMPLATE_APPROVED""KAKAOTALK_TEMPLATE_COMMENT_ADDED""KAKAOTALK_TEMPLATE_REJECTED""RCS_SENDER_COMMENT_ADDED"
curl -i -X POST \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/webhooks' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "secret": "{{WEBHOOK_SECRET}}",
    "target": "https://my.server.com/callback",
    "triggers": [
      "ALL"
    ]
  }'

Responses

Webhook created

Bodyapplication/json
idstringrequired

The ID of the webhook.

targetstringrequired

The target url where events will be sent to.

projectIdstringrequired

The project that this webhook belongs to.

triggersArray of strings(WebhookWebhookTriggers)uniquerequired

List of triggers this webhook is triggered by.

Items Enum"ALL""BUNDLE_DONE""KAKAOTALK_SENDER_ACTIVE""KAKAOTALK_SENDER_COMMENT_ADDED""KAKAOTALK_SENDER_INACTIVE""KAKAOTALK_SENDER_REJECTED""KAKAOTALK_TEMPLATE_APPROVED""KAKAOTALK_TEMPLATE_COMMENT_ADDED""KAKAOTALK_TEMPLATE_REJECTED""RCS_SENDER_COMMENT_ADDED"
Response
application/json

Example of a response when registering for all triggers.

{
  "id": "{{WEBHOOK_ID}}",
  "projectId": "{{PROJECT_ID}}",
  "target": "https://my.server.com/callback",
  "triggers": [
    "ALL"
  ]
}

Get webhookGA

Request

Return an already created webhook.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

The unique ID of the project. You can find this on the Sinch Dashboard.

webhookIdstringrequired

The unique ID of the webhook.

curl -i -X GET \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/webhooks/{webhookId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Webhook response

Bodyapplication/json
idstringrequired

The ID of the webhook.

targetstringrequired

The target url where events will be sent to.

projectIdstringrequired

The project that this webhook belongs to.

triggersArray of strings(WebhookWebhookTriggers)uniquerequired

List of triggers this webhook is triggered by.

Items Enum"ALL""BUNDLE_DONE""KAKAOTALK_SENDER_ACTIVE""KAKAOTALK_SENDER_COMMENT_ADDED""KAKAOTALK_SENDER_INACTIVE""KAKAOTALK_SENDER_REJECTED""KAKAOTALK_TEMPLATE_APPROVED""KAKAOTALK_TEMPLATE_COMMENT_ADDED""KAKAOTALK_TEMPLATE_REJECTED""RCS_SENDER_COMMENT_ADDED"
Response
application/json

Example of a response for a webhook with specific triggers.

{
  "id": "{{WEBHOOK_ID}}",
  "target": "https://my.server.com/callback",
  "projectId": "{{PROJECT_ID}}",
  "triggers": [
    "WHATSAPP_TEMPLATE_APPROVED",
    "WHATSAPP_TEMPLATE_REJECTED"
  ]
}

Bundles

The bundles endpoint allows you to create and manage bundles of account resources.

Operations

Conversation

The Conversation endpoints allows you to retrieve about channels used with Conversation API.

Operations

WhatsApp

The WhatsApp endpoint allows you to programmatically log in to and get details of your WhatsApp account.

Operations

WhatsApp Templates

The WhatsApp template endpoint offers a way for you to manage your WhatsApp templates that can be used with the Conversation API. The WhatsApp templates are a requirement to send the initial outbound messages in the WhatsApp API.

Operations

WhatsApp Senders

A WhatsApp Sender is also referred to as a 'Business Profile' or a WhatsApp channel. The WhatsApp Sender endpoint allows you to create a Sender through Meta's Embedded sign up. A Sender must be provisioned for you as a consumer of the WhatsApp API to send messages to your end users.

Operations

WhatsApp Accounts

The WhatsApp accounts endpoint lets you create and update WhatsApp accounts as well as get account activity and leave comments.

Operations

WhatsApp Flows

The WhatsApp flows endpoint lets you retrieve and manage WhatsApp Flows associated with the project.

Operations

WhatsApp Solutions

The WhatsApp solutions endpoint offers a way for you to manage your WhatsApp solutions.

Operations

KakaoTalk Templates

The KakaoTalk template endpoint offers a way for you to manage your KakaoTalk templates that can be used with the Conversation API.

Operations

KakaoTalk Categories

The KakoaTalk categories endpoint offers a way for you to manage all of the KakaoTalk template categories that you can use with the Conversation API.

Operations

KakaoTalk Senders

The KakaoTalk sender endpoint offers a way for you to manage your KakaoTalk senders that can be used with the Conversation API.

Operations

RCS Accounts

The RCS endpoint offers you a way to manage your RCS accounts.

Operations

RCS Questionnaire

Manage your RCS questionnaires.

Operations

RCS Senders

The RCS sender endpoint offers a way for you to manage your RCS senders that can be used with the Conversation API.

Operations

RCS Upscales

The RCS upscales endpoint offers a way for you to manage your RCS upscales.

Operations