API Documentation
API Endpoints/Webhooks

Workflow Webhook

This endpoint is used to receive workflow events from the Abillify platform. The events are triggered by the workflow engine asynchronously and are sent to the configured URL. Unsuccessfull Webhooks will be retried for up to 24 hours.

The events are sent as POST requests with a JSON payload. The payload is described in the event description.

HMAC-Signature can be enabled on request, this will add a X-Webhook-Signature Header with a SHA256-HMAC of the entire (unparsed) POST-Body.

client?string

Abillify Merchant ID

due?string

Due date of the voucher

identityReference?string

Your identity reference

job?string

ID of the job that sent the notificaiton

label?string

Label of the voucher

number?string

The vouchers number

ordernumber?string

Your order reference, if presented

state?string

State of the voucher

Value in"none" | "paid" | "canceled"
total?number

Total amount of the voucher, rounded to 2 decimal places

unpaid?number

Unpaid amount of the voucher, rounded to 2 decimal places

voucherReference?string

Your voucher reference

workflow?string

Name of your workflow

Response Body