Webhooks

List webhooks

List all webhooks for a given app as specified by the App ID.

SecurityBasic or oAuth2
Request
path Parameters
project_id
required
string

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

app_id
required
string

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

Responses
200

A successful response.

Response Schema: application/json
Array of objects (Webhook)

List of webhooks belonging to a specific project ID and app ID

Array
target
required
string

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

app_id
string

The app that this webhook belongs to.

object (ClientCredentials)

Optional. Used for OAuth2 authentication.

id
string

The ID of the webhook.

secret
string <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.

target_type
string (WebhookTargetType)
Default: "DISMISS"
Enum Value Description
DISMISS

Events won't be sent.

HTTP

Events will be sent to an HTTP target.

triggers
Array of strings (WebhookTrigger)

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.

Items Enum Value Description
UNSPECIFIED_TRIGGER

Using this value will cause errors.

MESSAGE_DELIVERY

Subscribe to delivery receipts for a message sent.

EVENT_DELIVERY

Subscribe to delivery receipts for a event sent.

MESSAGE_INBOUND

Subscribe to inbound messages from end users on the underlying channels.

EVENT_INBOUND

Subscribe to inbound events from end users on the underlying channels.

CONVERSATION_START

Subscribe to an event that is triggered when a new conversation has been started.

CONVERSATION_STOP

Subscribe to an event that is triggered when a active conversation has been stopped.

CONTACT_CREATE

Subscribe to an event that is triggered when a new contact has been created.

CONTACT_DELETE

Subscribe to an event that is triggered when a contact has been deleted.

CONTACT_MERGE

Subscribe to an event that is triggered when a two contacts are merged.

CONTACT_UPDATE

Subscribe to an event that is triggered when a contact is updated.

UNSUPPORTED

Subscribe to callbacks that are not natively supported by the Conversation API.

OPT_IN

Subscribe to opt_ins.

OPT_OUT

Subscribe to opt_outs.

CAPABILITY

Subscribe to see get capability results.

CONVERSATION_DELETE

Subscribe to get an event when a conversation is deleted.

CONTACT_IDENTITIES_DUPLICATION

Subscribe to get an event when contact identity duplications are found during message or event processing.

CHANNEL_EVENT

Subscribe to direct channel event.

SMART_CONVERSATION

Subscribe to Smart conversation analysis.

MESSAGE_INBOUND_SMART_CONVERSATION_REDACTION

Subscribe to analysis for messages from end-users.

RECORD_NOTIFICATION

Subscribe to Record Notifications.

MESSAGE_SUBMIT

Subscribe to message submit Notifications.

400

Malformed request. See common error responses for more information.

401

Incorrect credentials. See common error responses for more information.

403

Correct credentials but you don't have access to the requested resource. See common error responses for more information.

500

Correct credentials but you don't have access to the requested resource. See common error responses for more information.

501

Something went wrong on our end, try again with exponential back-off. See common error responses for more information.

get/v1/projects/{project_id}/apps/{app_id}/webhooks
Request samples 
Response samples 
application/json
{
  • "webhooks": [
    • {
      }
    ]
}
Create a new webhook
Creates a webhook for receiving callbacks on specific triggers.
You can create up to 5 webhooks per app.


SecurityBasic or oAuth2 
Request 
path Parameters
project_id
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
Request Body schema: application/json
required
Required. The Webhook to create


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


 
app_id
required
string
The app that this webhook belongs to.


 
object (ClientCredentials) 
Optional. Used for OAuth2 authentication.


 
secret
string <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.


 
target_type
string (WebhookTargetType) 
 Default:  "DISMISS"
 Enum Value Description
DISMISS
Events won't be sent.


HTTP
Events will be sent to an HTTP target.


 
triggers
Array of strings (WebhookTrigger) 
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.


Items Enum Value Description
UNSPECIFIED_TRIGGER
Using this value will cause errors.


MESSAGE_DELIVERY
Subscribe to delivery receipts for a message sent.


EVENT_DELIVERY
Subscribe to delivery receipts for a event sent.


MESSAGE_INBOUND
Subscribe to inbound messages from end users on the underlying channels.


EVENT_INBOUND
Subscribe to inbound events from end users on the underlying channels.


CONVERSATION_START
Subscribe to an event that is triggered when a new conversation has been started.


CONVERSATION_STOP
Subscribe to an event that is triggered when a active conversation has been stopped.


CONTACT_CREATE
Subscribe to an event that is triggered when a new contact has been created.


CONTACT_DELETE
Subscribe to an event that is triggered when a contact has been deleted.


CONTACT_MERGE
Subscribe to an event that is triggered when a two contacts are merged.


CONTACT_UPDATE
Subscribe to an event that is triggered when a contact is updated.


UNSUPPORTED
Subscribe to callbacks that are not natively supported by the Conversation API.


OPT_IN
Subscribe to opt_ins.


OPT_OUT
Subscribe to opt_outs.


CAPABILITY
Subscribe to see get capability results.


CONVERSATION_DELETE
Subscribe to get an event when a conversation is deleted.


CONTACT_IDENTITIES_DUPLICATION
Subscribe to get an event when contact identity duplications are found during message or event processing.


CHANNEL_EVENT
Subscribe to direct channel event.


SMART_CONVERSATION
Subscribe to Smart conversation analysis.


MESSAGE_INBOUND_SMART_CONVERSATION_REDACTION
Subscribe to analysis for messages from end-users.


RECORD_NOTIFICATION
Subscribe to Record Notifications.


MESSAGE_SUBMIT
Subscribe to message submit Notifications.


 
Responses 
200
A successful response.


Response Schema: application/json
target
required
string
The target url where events should be sent to.
Maximum URL length is 742.
The conversation-api.*.sinch.com subdomains are forbidden.


 
app_id
string
The app that this webhook belongs to.


 
object (ClientCredentials) 
Optional. Used for OAuth2 authentication.


 
id
string
The ID of the webhook.


 
secret
string <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.


 
target_type
string (WebhookTargetType) 
 Default:  "DISMISS"
 Enum Value Description
DISMISS
Events won't be sent.


HTTP
Events will be sent to an HTTP target.


 
triggers
Array of strings (WebhookTrigger) 
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.


Items Enum Value Description
UNSPECIFIED_TRIGGER
Using this value will cause errors.


MESSAGE_DELIVERY
Subscribe to delivery receipts for a message sent.


EVENT_DELIVERY
Subscribe to delivery receipts for a event sent.


MESSAGE_INBOUND
Subscribe to inbound messages from end users on the underlying channels.


EVENT_INBOUND
Subscribe to inbound events from end users on the underlying channels.


CONVERSATION_START
Subscribe to an event that is triggered when a new conversation has been started.


CONVERSATION_STOP
Subscribe to an event that is triggered when a active conversation has been stopped.


CONTACT_CREATE
Subscribe to an event that is triggered when a new contact has been created.


CONTACT_DELETE
Subscribe to an event that is triggered when a contact has been deleted.


CONTACT_MERGE
Subscribe to an event that is triggered when a two contacts are merged.


CONTACT_UPDATE
Subscribe to an event that is triggered when a contact is updated.


UNSUPPORTED
Subscribe to callbacks that are not natively supported by the Conversation API.


OPT_IN
Subscribe to opt_ins.


OPT_OUT
Subscribe to opt_outs.


CAPABILITY
Subscribe to see get capability results.


CONVERSATION_DELETE
Subscribe to get an event when a conversation is deleted.


CONTACT_IDENTITIES_DUPLICATION
Subscribe to get an event when contact identity duplications are found during message or event processing.


CHANNEL_EVENT
Subscribe to direct channel event.


SMART_CONVERSATION
Subscribe to Smart conversation analysis.


MESSAGE_INBOUND_SMART_CONVERSATION_REDACTION
Subscribe to analysis for messages from end-users.


RECORD_NOTIFICATION
Subscribe to Record Notifications.


MESSAGE_SUBMIT
Subscribe to message submit Notifications.


 
400
Malformed request. See common error responses for more information.


401
Incorrect credentials. See common error responses for more information.


403
Correct credentials but you don't have access to the requested resource. See common error responses for more information.


500
Correct credentials but you don't have access to the requested resource. See common error responses for more information.


501
Something went wrong on our end, try again with exponential back-off. See common error responses for more information.


post/v1/projects/{project_id}/webhooks
Request samples 
application/json
{
  • "target": "string"
}
Response samples 
application/json
{
  • "app_id": "string",
  • "client_credentials": {
    • "client_id": "string",
    • "client_secret": "pa$$word",
    • "endpoint": "string",
    • "scope": "string",
    • "response_type": "string",
    • "token_request_type": "BASIC"
    },
  • "id": "string",
  • "secret": "pa$$word",
  • "target": "string",
  • "target_type": "DISMISS",
  • "triggers": [
    • "MESSAGE_DELIVERY"
    ]
}
Get a webhook
Get a webhook as specified by the webhook ID.


SecurityBasic or oAuth2 
Request 
path Parameters
project_id
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
webhook_id
required
string
The unique ID of the webhook.


 
Responses 
200
A successful response.


Response Schema: application/json
target
required
string
The target url where events should be sent to.
Maximum URL length is 742.
The conversation-api.*.sinch.com subdomains are forbidden.


 
app_id
string
The app that this webhook belongs to.


 
object (ClientCredentials) 
Optional. Used for OAuth2 authentication.


 
id
string
The ID of the webhook.


 
secret
string <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.


 
target_type
string (WebhookTargetType) 
 Default:  "DISMISS"
 Enum Value Description
DISMISS
Events won't be sent.


HTTP
Events will be sent to an HTTP target.


 
triggers
Array of strings (WebhookTrigger) 
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.


Items Enum Value Description
UNSPECIFIED_TRIGGER
Using this value will cause errors.


MESSAGE_DELIVERY
Subscribe to delivery receipts for a message sent.


EVENT_DELIVERY
Subscribe to delivery receipts for a event sent.


MESSAGE_INBOUND
Subscribe to inbound messages from end users on the underlying channels.


EVENT_INBOUND
Subscribe to inbound events from end users on the underlying channels.


CONVERSATION_START
Subscribe to an event that is triggered when a new conversation has been started.


CONVERSATION_STOP
Subscribe to an event that is triggered when a active conversation has been stopped.


CONTACT_CREATE
Subscribe to an event that is triggered when a new contact has been created.


CONTACT_DELETE
Subscribe to an event that is triggered when a contact has been deleted.


CONTACT_MERGE
Subscribe to an event that is triggered when a two contacts are merged.


CONTACT_UPDATE
Subscribe to an event that is triggered when a contact is updated.


UNSUPPORTED
Subscribe to callbacks that are not natively supported by the Conversation API.


OPT_IN
Subscribe to opt_ins.


OPT_OUT
Subscribe to opt_outs.


CAPABILITY
Subscribe to see get capability results.


CONVERSATION_DELETE
Subscribe to get an event when a conversation is deleted.


CONTACT_IDENTITIES_DUPLICATION
Subscribe to get an event when contact identity duplications are found during message or event processing.


CHANNEL_EVENT
Subscribe to direct channel event.


SMART_CONVERSATION
Subscribe to Smart conversation analysis.


MESSAGE_INBOUND_SMART_CONVERSATION_REDACTION
Subscribe to analysis for messages from end-users.


RECORD_NOTIFICATION
Subscribe to Record Notifications.


MESSAGE_SUBMIT
Subscribe to message submit Notifications.


 
400
Malformed request. See common error responses for more information.


401
Incorrect credentials. See common error responses for more information.


403
Correct credentials but you don't have access to the requested resource. See common error responses for more information.


500
Correct credentials but you don't have access to the requested resource. See common error responses for more information.


501
Something went wrong on our end, try again with exponential back-off. See common error responses for more information.


get/v1/projects/{project_id}/webhooks/{webhook_id}
Request samples 
Response samples 
application/json
{
  • "app_id": "string",
  • "client_credentials": {
    • "client_id": "string",
    • "client_secret": "pa$$word",
    • "endpoint": "string",
    • "scope": "string",
    • "response_type": "string",
    • "token_request_type": "BASIC"
    },
  • "id": "string",
  • "secret": "pa$$word",
  • "target": "string",
  • "target_type": "DISMISS",
  • "triggers": [
    • "MESSAGE_DELIVERY"
    ]
}
Update an existing webhook
Updates an existing webhook as specified by the webhook ID.


SecurityBasic or oAuth2 
Request 
path Parameters
project_id
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
webhook_id
required
string
The unique ID of the webhook.


 
query Parameters
update_mask
Array of strings
The set of field mask paths.


 
Request Body schema: application/json
required
Required. The Webhook to update


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


 
app_id
string
The app that this webhook belongs to.


 
object (ClientCredentials) 
Optional. Used for OAuth2 authentication.


 
secret
string <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.


 
target_type
string (WebhookTargetType) 
 Default:  "DISMISS"
 Enum Value Description
DISMISS
Events won't be sent.


HTTP
Events will be sent to an HTTP target.


 
triggers
Array of strings (WebhookTrigger) 
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.


Items Enum Value Description
UNSPECIFIED_TRIGGER
Using this value will cause errors.


MESSAGE_DELIVERY
Subscribe to delivery receipts for a message sent.


EVENT_DELIVERY
Subscribe to delivery receipts for a event sent.


MESSAGE_INBOUND
Subscribe to inbound messages from end users on the underlying channels.


EVENT_INBOUND
Subscribe to inbound events from end users on the underlying channels.


CONVERSATION_START
Subscribe to an event that is triggered when a new conversation has been started.


CONVERSATION_STOP
Subscribe to an event that is triggered when a active conversation has been stopped.


CONTACT_CREATE
Subscribe to an event that is triggered when a new contact has been created.


CONTACT_DELETE
Subscribe to an event that is triggered when a contact has been deleted.


CONTACT_MERGE
Subscribe to an event that is triggered when a two contacts are merged.


CONTACT_UPDATE
Subscribe to an event that is triggered when a contact is updated.


UNSUPPORTED
Subscribe to callbacks that are not natively supported by the Conversation API.


OPT_IN
Subscribe to opt_ins.


OPT_OUT
Subscribe to opt_outs.


CAPABILITY
Subscribe to see get capability results.


CONVERSATION_DELETE
Subscribe to get an event when a conversation is deleted.


CONTACT_IDENTITIES_DUPLICATION
Subscribe to get an event when contact identity duplications are found during message or event processing.


CHANNEL_EVENT
Subscribe to direct channel event.


SMART_CONVERSATION
Subscribe to Smart conversation analysis.


MESSAGE_INBOUND_SMART_CONVERSATION_REDACTION
Subscribe to analysis for messages from end-users.


RECORD_NOTIFICATION
Subscribe to Record Notifications.


MESSAGE_SUBMIT
Subscribe to message submit Notifications.


 
Responses 
200
A successful response.


Response Schema: application/json
target
required
string
The target url where events should be sent to.
Maximum URL length is 742.
The conversation-api.*.sinch.com subdomains are forbidden.


 
app_id
string
The app that this webhook belongs to.


 
object (ClientCredentials) 
Optional. Used for OAuth2 authentication.


 
id
string
The ID of the webhook.


 
secret
string <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.


 
target_type
string (WebhookTargetType) 
 Default:  "DISMISS"
 Enum Value Description
DISMISS
Events won't be sent.


HTTP
Events will be sent to an HTTP target.


 
triggers
Array of strings (WebhookTrigger) 
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.


Items Enum Value Description
UNSPECIFIED_TRIGGER
Using this value will cause errors.


MESSAGE_DELIVERY
Subscribe to delivery receipts for a message sent.


EVENT_DELIVERY
Subscribe to delivery receipts for a event sent.


MESSAGE_INBOUND
Subscribe to inbound messages from end users on the underlying channels.


EVENT_INBOUND
Subscribe to inbound events from end users on the underlying channels.


CONVERSATION_START
Subscribe to an event that is triggered when a new conversation has been started.


CONVERSATION_STOP
Subscribe to an event that is triggered when a active conversation has been stopped.


CONTACT_CREATE
Subscribe to an event that is triggered when a new contact has been created.


CONTACT_DELETE
Subscribe to an event that is triggered when a contact has been deleted.


CONTACT_MERGE
Subscribe to an event that is triggered when a two contacts are merged.


CONTACT_UPDATE
Subscribe to an event that is triggered when a contact is updated.


UNSUPPORTED
Subscribe to callbacks that are not natively supported by the Conversation API.


OPT_IN
Subscribe to opt_ins.


OPT_OUT
Subscribe to opt_outs.


CAPABILITY
Subscribe to see get capability results.


CONVERSATION_DELETE
Subscribe to get an event when a conversation is deleted.


CONTACT_IDENTITIES_DUPLICATION
Subscribe to get an event when contact identity duplications are found during message or event processing.


CHANNEL_EVENT
Subscribe to direct channel event.


SMART_CONVERSATION
Subscribe to Smart conversation analysis.


MESSAGE_INBOUND_SMART_CONVERSATION_REDACTION
Subscribe to analysis for messages from end-users.


RECORD_NOTIFICATION
Subscribe to Record Notifications.


MESSAGE_SUBMIT
Subscribe to message submit Notifications.


 
400
Malformed request. See common error responses for more information.


401
Incorrect credentials. See common error responses for more information.


403
Correct credentials but you don't have access to the requested resource. See common error responses for more information.


500
Correct credentials but you don't have access to the requested resource. See common error responses for more information.


501
Something went wrong on our end, try again with exponential back-off. See common error responses for more information.


patch/v1/projects/{project_id}/webhooks/{webhook_id}
Request samples 
application/json
{
  • "target": "string"
}
Response samples 
application/json
{
  • "app_id": "string",
  • "client_credentials": {
    • "client_id": "string",
    • "client_secret": "pa$$word",
    • "endpoint": "string",
    • "scope": "string",
    • "response_type": "string",
    • "token_request_type": "BASIC"
    },
  • "id": "string",
  • "secret": "pa$$word",
  • "target": "string",
  • "target_type": "DISMISS",
  • "triggers": [
    • "MESSAGE_DELIVERY"
    ]
}
Delete an existing webhook
Deletes a webhook as specified by the webhook ID.


SecurityBasic or oAuth2 
Request 
path Parameters
project_id
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
webhook_id
required
string
The unique ID of the webhook.


 
Responses 
200
A successful response.


400
Malformed request. See common error responses for more information.


401
Incorrect credentials. See common error responses for more information.


403
Correct credentials but you don't have access to the requested resource. See common error responses for more information.


500
Correct credentials but you don't have access to the requested resource. See common error responses for more information.


501
Something went wrong on our end, try again with exponential back-off. See common error responses for more information.


delete/v1/projects/{project_id}/webhooks/{webhook_id}
Request samples 
Response samples 
application/json
{
  • "code": 400,
  • "message": "Malformed request",
  • "status": "INVALID_REQUEST",
  • "details": [ ]
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2025 Sinch. All rights reserved.