FAQ
What happens if my server is down when a webhook is sent?
If your server is down when a webhook is sent, the request will fail and the webhook will not be delivered. The platform will retry the delivery of the webhook at increasing intervals, starting with 1 minute and increasing to 2, 4, ... minutes. If the webhook is still not delivered after 13 attempts, the platform will stop trying to deliver the webhook.
How can I test my webhook endpoint?
In your webhook listener settings (Project Settings > Integration > Webhooks), you can use the "Send Test Event" feature to simulate different events and confirm that your endpoint is processing them correctly.
How can I ensure that my webhook endpoint is secure?
To ensure the security of your webhook endpoint, consider the following best practices:
- Originating IP Address Verification: Whitelist the platform's static IP addresses to ensure that only requests from trusted sources are accepted.
- Payload HMAC Signature Verification: Verify the authenticity of incoming payloads by validating the HMAC signature included in the
X-Synaps-Signature
header. - Preventing Replay Attacks: Implement safeguards such as notification expiration and idempotency keys to protect against replay attacks and duplicate processing.
You can find more details on these security measures in the Security section.
How can I retry an event that failed to be delivered?
You can manually retry an event that failed to be delivered by resending the event from the platform's interface. In the webhook listener settings, you can view the events that were sent to your listener and manually resend any failed events.