Webhooks

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

List all webhooks in project GA 

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.
SecurityBasic or OAuth2.0
Request
path Parameters
projectId
required
string

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

query Parameters
pageToken
string

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

pageSize
number [ 1 .. 15 ]

The page size requested.

Responses
200

List of webhooks

Response Schema: application/json
totalSize
required
number

Total size of the entries matching the search query.

pageSize
required
number

Requested size of the page.

required
Array of objects (WebhookWebhookDto)
previousPageToken
string

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

nextPageToken
string

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

400

BadRequest

401

Unauthorized

500

InternalServerError

get/v1/projects/{projectId}/webhooks
Request samples 
Response samples 
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 project GA 
Register a new webhook for a project. The webhook will be used to communicate updates to resources. Maximum of `15` webhooks allowed per project.



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


 
Request Body schema: application/json
required
Webhook to register


target
required
string <url>   [ 1 .. 742 ] characters 
A valid target url where events should be sent to.


 
secret
required
string  [ 1 .. 128 ] characters 
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.


 
triggers
required
Array of strings (WebhookWebhookTrigger)   non-empty  unique 
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" "RCS_SENDER_OPERATOR_STATUS_UPDATED" "RCS_SENDER_STATUS_UPDATED" "RCS_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_ONBOARDED" "WHATSAPP_ACCOUNT_PENDING_VERIFICATION" "WHATSAPP_ACCOUNT_REJECTED" "WHATSAPP_WABA_ACCOUNT_CHANGED" "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" "WHATSAPP_SENDER_REJECTED" "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" "WHATSAPP_TEMPLATE_STATUS_UPDATED"  
Responses 
201
Webhook created


Response Schema: application/json
id
required
string
The ID of the webhook.


 
target
required
string
The target url where events will be sent to.


 
projectId
required
string
The project that this webhook belongs to.


 
triggers
required
Array of strings (WebhookWebhookTrigger)   unique 
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" "RCS_SENDER_OPERATOR_STATUS_UPDATED" "RCS_SENDER_STATUS_UPDATED" "RCS_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_ONBOARDED" "WHATSAPP_ACCOUNT_PENDING_VERIFICATION" "WHATSAPP_ACCOUNT_REJECTED" "WHATSAPP_WABA_ACCOUNT_CHANGED" "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" "WHATSAPP_SENDER_REJECTED" "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" "WHATSAPP_TEMPLATE_STATUS_UPDATED"  
400
BadRequest


401
Unauthorized


409
Conflict


424
FailedDependency


500
InternalServerError


post/v1/projects/{projectId}/webhooks
Request samples 
application/json
{}
Response samples 
application/json
Example of a response when registering for all triggers.



{}
Get webhook GA 
Return an already created webhook.



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


 
webhookId
required
string
The unique ID of the webhook.


 
Responses 
200
Webhook response


Response Schema: application/json
id
required
string
The ID of the webhook.


 
target
required
string
The target url where events will be sent to.


 
projectId
required
string
The project that this webhook belongs to.


 
triggers
required
Array of strings (WebhookWebhookTrigger)   unique 
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" "RCS_SENDER_OPERATOR_STATUS_UPDATED" "RCS_SENDER_STATUS_UPDATED" "RCS_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_ONBOARDED" "WHATSAPP_ACCOUNT_PENDING_VERIFICATION" "WHATSAPP_ACCOUNT_REJECTED" "WHATSAPP_WABA_ACCOUNT_CHANGED" "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" "WHATSAPP_SENDER_REJECTED" "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" "WHATSAPP_TEMPLATE_STATUS_UPDATED"  
400
BadRequest


401
Unauthorized


404
NotFound


500
InternalServerError


get/v1/projects/{projectId}/webhooks/{webhookId}
Request samples 
Response samples 
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"
    ]
}
Delete webhook GA 
Deletes an already created webhook.



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


 
webhookId
required
string
The unique ID of the webhook.


 
Responses 
204
Webhook deleted


400
BadRequest


401
Unauthorized


404
NotFound


500
InternalServerError


delete/v1/projects/{projectId}/webhooks/{webhookId}
Request samples 
Response samples 
application/json
{
  • "errorCode": "webhook_invalid_id",
  • "message": "Webhook ID is invalid.",
  • "resolution": "Verify that the format of the string ID is the same as originally returned when created."
}
Replace webhook GA 
Replace an already existing webhook.



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


 
webhookId
required
string
The unique ID of the webhook.


 
Request Body schema: application/json
required
Webhook to replace


target
required
string <url>   [ 1 .. 742 ] characters 
A valid target url where events should be sent to.


 
secret
required
string  [ 1 .. 128 ] characters 
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.


 
triggers
required
Array of strings (WebhookWebhookTrigger)   non-empty  unique 
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" "RCS_SENDER_OPERATOR_STATUS_UPDATED" "RCS_SENDER_STATUS_UPDATED" "RCS_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_ONBOARDED" "WHATSAPP_ACCOUNT_PENDING_VERIFICATION" "WHATSAPP_ACCOUNT_REJECTED" "WHATSAPP_WABA_ACCOUNT_CHANGED" "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" "WHATSAPP_SENDER_REJECTED" "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" "WHATSAPP_TEMPLATE_STATUS_UPDATED"  
Responses 
200
Webhook response


Response Schema: application/json
id
required
string
The ID of the webhook.


 
target
required
string
The target url where events will be sent to.


 
projectId
required
string
The project that this webhook belongs to.


 
triggers
required
Array of strings (WebhookWebhookTrigger)   unique 
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" "RCS_SENDER_OPERATOR_STATUS_UPDATED" "RCS_SENDER_STATUS_UPDATED" "RCS_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_ONBOARDED" "WHATSAPP_ACCOUNT_PENDING_VERIFICATION" "WHATSAPP_ACCOUNT_REJECTED" "WHATSAPP_WABA_ACCOUNT_CHANGED" "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" "WHATSAPP_SENDER_REJECTED" "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" "WHATSAPP_TEMPLATE_STATUS_UPDATED"  
400
BadRequest


401
Unauthorized


404
NotFound


409
Conflict


500
InternalServerError


put/v1/projects/{projectId}/webhooks/{webhookId}
Request samples 
application/json
{}
Response samples 
application/json
Example of a response for an update to specific triggers.



{
  • "id": "{{WEBHOOK_ID}}",
  • "projectId": "{{PROJECT_ID}}",
  • "target": "https://my.server.com/callback",
  • "triggers": [
    • "WHATSAPP_TEMPLATE_APPROVED",
    • "WHATSAPP_TEMPLATE_REJECTED"
    ]
}
Update webhook GA 
Update an already existing webhook.



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


 
webhookId
required
string
The unique ID of the webhook.


 
Request Body schema: application/json
required
Webhook to update


target
object <url>   [ 1 .. 742 ] characters 
A valid target url where events should be sent to.


 
secret
object  [ 1 .. 128 ] characters 
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.


 
triggers
Array of strings (WebhookWebhookTrigger)   non-empty  unique 
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" "RCS_SENDER_OPERATOR_STATUS_UPDATED" "RCS_SENDER_STATUS_UPDATED" "RCS_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_ONBOARDED" "WHATSAPP_ACCOUNT_PENDING_VERIFICATION" "WHATSAPP_ACCOUNT_REJECTED" "WHATSAPP_WABA_ACCOUNT_CHANGED" "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" "WHATSAPP_SENDER_REJECTED" "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" "WHATSAPP_TEMPLATE_STATUS_UPDATED"  
Responses 
200
Webhook response


Response Schema: application/json
id
required
string
The ID of the webhook.


 
target
required
string
The target url where events will be sent to.


 
projectId
required
string
The project that this webhook belongs to.


 
triggers
required
Array of strings (WebhookWebhookTrigger)   unique 
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" "RCS_SENDER_OPERATOR_STATUS_UPDATED" "RCS_SENDER_STATUS_UPDATED" "RCS_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_COMMENT_ADDED" "WHATSAPP_ACCOUNT_ONBOARDED" "WHATSAPP_ACCOUNT_PENDING_VERIFICATION" "WHATSAPP_ACCOUNT_REJECTED" "WHATSAPP_WABA_ACCOUNT_CHANGED" "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" "WHATSAPP_SENDER_REJECTED" "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" "WHATSAPP_TEMPLATE_STATUS_UPDATED"  
400
BadRequest


401
Unauthorized


404
NotFound


409
Conflict


500
InternalServerError


patch/v1/projects/{projectId}/webhooks/{webhookId}
Request samples 
application/json
{}
Response samples 
application/json
Example of a response for an update to specific triggers.



{
  • "id": "{{WEBHOOK_ID}}",
  • "projectId": "{{PROJECT_ID}}",
  • "target": "https://my.server.com/callback",
  • "triggers": [
    • "WHATSAPP_TEMPLATE_APPROVED",
    • "WHATSAPP_TEMPLATE_REJECTED"
    ]
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2025 Sinch. All rights reserved.