You can set up callback URLs to receive event notifications when your numbers are updated.
When delivering events the order is not guaranteed (for example, a failed event scheduled for retry will not block other events that were queued).
The client's callback handler must implement the state machine that can decide what to do with unexpected events, for example, "old" events or invalid state transitions. In these cases the handler could use the API to GET the latest state for the resource.
The callback handler is expected to "ingest" the event and respond with 200 OK. The domain-specific business logic and processes should be executed outside of the callback request, as internal asynchronous jobs.
You can also add an HMAC encrypted secret which is used for hashing the payload and sending the hashed String via the X-Sinch-Signature
header - that you can use to validate that an incoming request is secure.
To use callbacks, add the following IP addresses to your allowlist:
- 54.76.19.159
- 54.78.194.39
- 54.155.83.128
Returns the callbacks configuration for the specified project
projectId required | string Found on your Sinch Customer Dashboard. Settings > Projects. Example: d1923022-5199-4bb3-a513-c47b3a656bc5 |
Callbacks configuration
400 Invalid Argument error
404 Not Found error
500 Internal Server error
{- "projectId": "a99aa9aa-b888-777c-dd6d-ee55e5555555",
- "hmacSecret": "YOUR_hmac_secret"
}
Updates the callbacks configuration for the specified project
projectId required | string Found on your Sinch Customer Dashboard. Settings > Projects. Example: d1923022-5199-4bb3-a513-c47b3a656bc5 |
The callback configuration details to be updated.
Callback configuration
400 Invalid Argument error
404 Not Found error
500 Internal Server error
{ }
{- "projectId": "a99aa9aa-b888-777c-dd6d-ee55e5555555",
- "hmacSecret": "YOUR_hmac_secret"
}
A notification of an event sent to your configured callback URL.
200 OK
{- "eventId": "abcd1234efghijklmnop567890",
- "timestamp": "2023-06-06T07:45:27.785357",
- "projectId": "abcd12ef-ab12-ab12-bc34-abcdef123456",
- "resourceId": "+12345612345",
- "resourceType": "IMPORTED_NUMBER",
- "eventType": "LINK_TO_10DLC_CAMPAIGN",
- "status": "FAILED",
- "failureCode": "CAMPAIGN_NOT_AVAILABLE"
}