Webhooks

Create a new webhook

Creates a webhook for receiving callbacks on specific triggers. You can create up to 5 webhooks per app.

post/v1/projects/{project_id}/webhooks

Request

Base URL
https://us.conversation.api.sinch.com
URL
https://us.conversation.api.sinch.com/v1/projects/{project_id}/webhooks
Auth
- HTTP basic
- or OAuth 2
  Client credentials
  Token URL: https://auth.sinch.com/oauth2/token

Request body

app_idstring required

The app that this webhook belongs to.

idstring

The ID of the webhook.

secretstring password

Optional secret be used to sign contents of webhooks sent by the Conversation API. You can then use the secret to verify the signature.

targetstring required

The target url where events should be sent to. Maximum URL length is 742. The conversation-api.*.sinch.com subdomains are forbidden.

target_type'DISMISS' | 'HTTP'

triggersWebhookTrigger[]

An array of triggers that should trigger the webhook and result in an event being sent to the target url. Refer to the list of Webhook Triggers for a complete list.

Example request

{
  "triggers": [
    "MESSAGE_DELIVERY"
  ]
}

Response

A successful response.

app_idstring