Webhooks
Push notifications from events within Arratech's solution are available via webhooks. Register a webhook to an http endpoint (callback handler) you control and receive calls to that endpoint each time the corresponding event occurs.
Your callback handler must respond HTTP 200 for a successful delivery. The response body is not evaluated. If your processing takes time, we recommend returning a 200 response immediately and handling the payload asynchronously.
In case your callback handler is unavailable the notification delivery is retried up to 2 times (3 total delivery attempts). If you still miss the delivery (e.g. due to an extended unavailability of your callback handler) the API also contains endpoints for listing the received events retroactively. Each event is stored for 14 days.
The API currently supports a very limited set of events but the list of supported events will grow continuously.
Supported Events
| Event Name | Payload | Note |
|---|---|---|
| transaction.received | TBD | Triggered when a transaction is received |
| transaction.sent | TBD | Triggered when a transaction is successfully sent |
| webhook.test | TBD | Triggered via the trigger-test-event endpoint by specifying this event in the payload. |
Endpoints
For information only. Full, normative endpoint definitions in the Swagger documentation.
| Endpoint | Description | Role |
|---|---|---|
| GET /orgs/:orgId/webhooks | List all webhooks that this organisation has registered | orgadmin |
| GET /orgs/:orgId/webhooks/:id | Get one specific webhook | orgadmin |
| POST /orgs/:orgId/webhooks | Create/register a webhook | orgadmin |
| PUT /orgs/:orgId/webhooks/:id | Update a webhook | orgadmin |
| POST /orgs/:orgId/webhooks/batch-delete | Delete one or more webhooks | orgadmin |
| POST /orgs/:orgId/webhooks/trigger-test-event | Manually trigger an event | orgadmin |
| GET /orgs/:orgId/webhooks/events | List all webhook events | orgadmin |
| GET /orgs/:orgId/webhooks/events/:id | Get one specific webhook event | orgadmin |
Example Webhook datatype
{
"type": "WEBHOOK",
"id": "123e4567-e89b-12d3-a456-426614174000",
"orgId": "550e8400-e29b-41d4-a716-446655440000",
"description": "Webhook for transaction events",
"events": [
"transaction.received",
"transaction.sent"
],
"url": "https://example.com/webhook-endpoint",
"isEnabled": true,
"createdBy": {
"userId": "123e4567-e89b-12d3-a456-426614174000"
},
"createdAt": "2025-09-12T08:00:00Z",
"lastModifiedBy": {
"userId": "123e4567-e89b-12d3-a456-426614174000"
},
"lastModifiedAt": "2025-09-13T09:30:00Z"
}