Webhooks
Supported scenarios
- Subscribe to events;
- Unsubscribe from events.
For the business rules concerning webhooks, please read Webhooks.
Subscribe to events
Purpose
Supplier application subscribes organization events to be posted by Floriday at the specified callbackURL. Starting with sales order events: accepted, committed, cancelled and corrected.
Process steps
NR | Process step | API call / scenario |
---|---|---|
1 | Supplier application subscribes organization events to be posted by Floriday at the specified callbackURL. Starting with sales order events: accepted, committed, cancelled and corrected. | AddWebhookSubscription |
2/3 | Floriday posts a message with a subscribeURL on the callbackURL. | |
4/5 | Supplier application confirms registration by using a GET on the subscribeURL. Non confirmed registrations will be deleted after 72h. | |
After registration Supplier application will receive events on the given callbackURL. |
- Supplier application can add more then one callbackURL for an organization.
- Supplier applications can share one callbackURL for multiple organizations.
- For technical reasons a maximum of 120 organizations can share one callbackURL.
- It is advised not to use to many callbackURL for Supplier application maintenance purposes.
For technical documentation on the callbackURL please refer to:
https://docs.aws.amazon.com/sns/latest/dg/sns-verify-signature-of-message.html
Unsubscribe from events
Purpose
Supplier application unsubscribe organization for posting events for the specified callbackURL.
Process steps
NR | Process step | API call / scenario |
---|---|---|
1 | Supplier application unsubscribe organization for posting events for the specified callbackURL | DeleteWebhookSubscription |
If after unsubscribing no organization has a subscription to the callbackURL, the subscription/registration of the callbackURL is deleted. | ||
After unsubscribing events Supplier application will no longer receive events on the given callbackURL. |
Retry configuration
Floriday has the current retry configuration:
"minDelayTarget": 20,
"maxDelayTarget": 20,>
"numRetries": 3,
"numMaxDelayRetries": 0,
"numNoDelayRetries": 0,
"numMinDelayRetries": 0,
"backoffFunction": "linear"
After the initial attempt to delivery the message, 3 additional attempts will follow with an interval of 20s between the attempts.
For technical documentation on the 'message delivery retry' please refer to:
https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html#creating-delivery-policy
Updated 9 months ago