Event notifications

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.

What are webhooks

Webhooks refer to a composite event with an object. Webhooks are like a phone call that Upodi rings to notify you of an event. The event could be the creation of a new customer or the payment of a subscription. The webhook endpoint is the system answering that phone call who takes actions based upon the specific information it receives.

Notifications are Event objects. This Event object contains all the relevant information about what just happened, including the type of event and the data associated with that event. The webhook endpoint uses the event details to take any required actions, such as indicating that an order should be fulfilled.

Durability

Webhooks are sent immediately upon the event. We queue each request and will replay the event until your endpoint returns a HTTP 2xx response (normally 200). If we receive anything other than a 2xx response, or we get no response at all, we first pause the event for 30 minutes and then replay the event. From there on we pause the webhook for 3 hours and repeat this replaying for up to 72 hours or until we receive a successful response. After this grace period we discard the call, log the event and stop sending the webhook.

🚧

Order of events

When dealing with webhooks, events may be un-ordered due to the delivery of the events. Durability and size of the event payload may change the order in which the event is sent.

A common pattern is to capture events over a period of time and Use the Time property of the payload to compare the order of the event.

How we handle webhooks

Upodi sends webhooks to any public available webserver as HTTP POST. You can specify multiple endpoints in the Upodi application. Each endpoint will recieve a copy of all events.

Summarized:

• Enable a public available web endpoint using HTTP (port 80) or HTTPS (port 443).
• We will keep retrying the webhook endpoint ever 3 hours until we receive a 2xx for up to 72 hours.
• Upodi catches the response code.
• 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.

This is an example of a webhook body (customer, create event):

{
  "ID" : "f07b8521-4421-4de6-96a5-178cf498cfef",
  "Time" : 131516890300860922,
  "Signature" : YTYxNWEzMdItZTBgg5i00YWE4LTk5tu6rh2JiZmEyODk5OGMz,
  "Action" :"create",
  "Issuer" : {
    "Url" : "/Customer/create/0ea627de-158e-48b1-bcbb-7fe6058d191c",
    "Identifier":"0ea627de-158e-48b1-bcbb-7fe6058d191c"
  },
  "Data" : null,
  "Type" : 
  "Customer"
}

📘

Need to test a webhook?

Services like Webhook Site enable quick test of the webhook calls from Upodi. Setup a Webhook.site endpoint and add the URL to the Upodi webhook.

Events
The followings events are sent from Upodi, to endpoint configured under webhooks.

Subscribe via API

You can subscribe via the API using a flagged enum when you want to subscribe for more than one event at a time. In the below case 3 as the value means I subscribe to both Customer Created and Customer Updated events.

curl --request POST \
     --url https://api-front.upodi.io/Webhooks \
     --header 'Authorization: Bearer {ApiKey}' \
     --header 'X-version: {version}' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "EventNotificationEnum": 3,
  "Url": "https://mysystem.com/notifymehere",
  "FullName": "notify me on customer creations"
}
'