Webhooks (Callbacks)

Overview

Webhooks allow you to receive real-time notifications about events in your organization. You can register multiple webhooks, each with its unique endpoint, to handle different types of events.

Event Types

The following webhooks are available:

  • guarantee.created: Triggered each time a new guarantee is created within your organization.
  • guarantee.updated: Triggered each time an existing guarantee is updated.
  • guarantee.notorized: Triggered when a guarantee has been correctly notarized on the blockchain.
  • guarantee.notorization_failed: Triggered when a guarantee could not be properly notarized on the blockchain.

Webhook Payload

When an event occurs, the payload sent to your webhook endpoint will be in the following format:

{
   "type": "event type from the ones mentioned above",
   "payload": {
        "guarantee": {the full guarantee object}
   }
}

Delivery and Retries

Webhooks are retried up to 5 times with exponential backoff before stopping the delivery. This ensures reliable event notifications even if there are temporary issues with your webhook endpoint.