Skip to content

Webhook

Boi-das can provide a webhook that sends real-time notifications whenever a validation is accepted or denied within our product. When a validation's status changes, a notification is sent to the URL specified by the client with relevant data.

Webhook Server Requirements

When setting up a webhook endpoint, it's crucial to ensure that your server is properly secured. To do so, it should meet the requirements hereunder.

  • Webhook URL: Ensure you provide a valid URL to receive the webhook notifications.
  • HTTPS Protocol: To ensure a secure and encrypted connection between our system and the customer's system, the URL provided shall use the HTTPS protocol.
  • OAuth Authentication: The URL shall be protected by an OAuth authentication mechanism. This verifies the identity of the webhook sender and ensures that only our system can send requests to that URL.
  • Availability: The URL shall be available and accessible at all times to ensure timely delivery of webhooks.
  • Supported Formats: JSON.

Also, check out the environment variables required in boi-Das configuration.

Webhook Server API

Leveraging boi-Das API

Consider exploring the endpoints explained in the API section of boi-Das documentation to automate webhook requests and verify responses. You will find information on the following:

  • How to query all status change events.
  • How to filter for events where the webhook notification was not sent successfully or not.
  • How to query a specific event
  • How to filter for validations where the webhook notification was not sent successfully or not.
  • How to get all events for a specific validation

Important

In order for the event endpoints to work, the Webhook must be enabled and working. Check out POST /test-webhook endpoint available to check if the webhook is properly set up.