Access Point information

Webhooks

The webhook system allows you to retrieve updates without having to keep polling. The moment the accesspoint receives an update we will push this to the provided endpoint. For invoice statuses we advice our message webhook. This will listen to any update regarding the invoice delivery statuses.

How to use the Billit Webhooks

The Billit webhooks push HTTPS calls to the registered URL provided. We will send a JSON payload to your integration. This data can be used to execute actions in you backend systems.

Steps to receive a webhook

  1. Create the webhook
    Endpoint: v1/einvoices/registrations/{registrationID}/webhooks
    Method: POST
    Body:
{
    "EntityType" : "Order",
    "EntityUpdateType" : "I",
    "WebhookURL" : "{Returned ID}"
}
  1. Handle the returned request. This payload will provide you a Secret. This secret can be used to verify incomming webhooks
  2. You can delete or retrieve webhooks via the API
  3. If needed you can refresh the Secret by using the API endpoint

The Webhooks will soon be visible in the web application.

Webhook Signatures

We sign all webhooks we send out with a signature. This Signature can be decrypted by using the Secret we provided you when creating the webhook.

SSL

Please make sure the endpoint has an active SSL domain. We will refuse to send webhooks to otherwise

Webhook Entity Types

TypeDefinition
OrderOrders, creditnotes, deliverynotes, ...
MessageMessage contains all digital Transport Types

Webhook Update Types

TypeDefinition
IA new entity
UUpdated entity
DDeleted entity