To configure webhook communication, the partner must provide:
Webhook setup requirements
To setup the comunication between Sorte Online and the partner, we need the following information in advance.
- The base URL for a set of endpoints (webhooks) (Test and Production environment)
- The authentication mechanism
- We are able to use API Token and Oauth 2.0
- If using Oauth 2.0, we also need the endpoint to obtain a valid JWT Token.
- The need to register our IPs in an internal whitelist
Response
Based on your response, it will be analyzed whether the event was successful or not. By default, up to 4 attempts will be made using exponential backoff.
| Status | DESCRIPTION | FIX |
|---|---|---|
| 4xx | We may encounter a 400 error due to payload inconsistency. 401 and 403 errors may occur if there are issues with the access credentials to the endpoint, such as expired or incorrect credentials. A 404 error indicates that the route was not found. | - Make sure that your endpoint is publicly accessible to the internet. |
| 5xx | The destination server encountered an error while processing the request. | Check application Logs to understand what is happening. |
| (Timed out) | For default our services will considering a timeout if the request waits more than 10 seconds to get a response. | Check application Logs to understand what is happening. |
Example of what we need:
{
"baseUrl": "https://partnerapi",
"apiKey": "asdas-asdas-asdas-asdas",
"uriCancelation": "/cancel",
"uriConfirmation": "/confirm",
"uriDrawResult": "/draw-result",
"uriRedemptionConfirmation": "/redemption/confirm",
"uriPixCode": "/pix-code"
}