Webhooks

Manage your webhooks to lets Synaps notify you when a session has been updated.

Create a new webhook

To create a new webhook, click on Webhooks tabs in your app dashboard, enter your payload URL click on the green switch to enable webhook

Webhook Deliveries

For each webhook that we send to your payload URL, we are saving the response output to help you debug in case of errors.

Webhook Request

You should create a POST request in your Private API that will take as JSON Content-Type and will receive the following object

VALIDATED WEBHOOK

{
"session_id":"1a106e0f-7ceb-79be-7943-47ae1ef4",
"state":"VALIDATED"
}

REJECTED WEBHOOK

{
"session_id":"1a106e0f-7ceb-79be-7943-47ae1ef4",
"state":"REJECTED"
}

INCOMPLETE WEBHOOK

{
"session_id":"1a106e0f-7ceb-79be-7943-47ae1ef4",
"state":"INCOMPLETE"
}

Basically we are sending the session_id and the state, we don't disclose any private information through the webhook. You should always make a call to /details in order to fetch user information.

We are sending a secret value as a query parameter in the POST request. This secret is unique to your app and is available in your manager. Double-check this value each time you receive a webhook to make sure that Synaps is the one who sends this request.