Webhooks are used as a messaging channel, to keep line of business systems synchronized with events inside Upodi. A webhook cannot be used as a reliable state of an object or action. The webhook should be used for event notification in conjunction with the API.

Upodi sends webhooks to any public available webserver as HTTP POST. You can specify multiple endpoints in the Upodi application.

Upon an event, Upodi will trigger a webhook and try to send this notification to the endpoint configured. We process all webhooks using the following policies:

  • Timeout is set to 5 seconds.
  • Upodi expect a 2xx response in return, or will delay the message for re-play.
  • We re-play for a period of 3 days every 3rd hour.

Summarized:

  • Enable a public available web endpoint using HTTP (port 80) or HTTPS (port 443).
  • Your endpoint must be live and capture the event within 5 seconds.
  • Method is POST.
  • "Signature" will correspond to the authenticity token, and can be used to verify the source.

Webhook body
A webhook holds various information and details. Please make a sample to monitor the response formats.