Supported Events

Below are the support events available for subscription. Contact your account manager for information on accessing custom events.

Examples shared below for each event type will be sent to your URL handler within the payloadfield of the HTTP request. You can check the full HTTP request structure below:

{
	"event": "<event-name>",
	"eventId": "<unique event id>",
	"version": "<version-of-the-event-payload>",
	"payload": {
		// detailed payload fields vary per event type
	}
}

Webhook Test Event

This event only sent when the webhook test API is triggered. Should only be used for connectivity testing purposes.

Event Name: webhook.test

Event Version: 1

Example Payload Field

{
    "response": "<data added to your test request>"
}

Transaction State Events

Transactions having a complicated flow of execution. Especially, when you initiate payments using API platform. State change events are only triggered when a transaction state is changed to COMPLETED CANCELLED and FAILED states. You won't get webhooks for interim state changes.

Event Name: transaction.state-changed

Event Version: 1

Example Payload Field

{
  "transactionId": "d73c211c-10dc-47a0-9397-499ec2136d02",
  "origin": "TRANSFER",
  "state": "COMPLETED",
  "category": "TRANSFERS",
  "impactType": "CREDIT",
  "customerId": "995674ee-79fa-4873-b6f5-67c43574baf0",
  "amount": 100,
  "currencyCode": "GBP",
  "description": "Sent from Algbra",
  "exchangeRate": "1",
  "exchangeCurrencyCode": "GBP",
  "transactionDate": "2025-01-27T12:32:02.824Z",
  "sourceCounterparty": {
    "type": "PERSONAL",
    "details": { "firstName": "[REDACTED]", "lastName": "[REDACTED]" },
    "accountCurrency": "GBP",
    "accountReference": { "accountNumber": "[REDACTED]", "sortCode": "[REDACTED]" },
    "accountReferenceType": "UK_ACCOUNT"
  },
  "destinationCounterparty": {
    "type": "PERSONAL",
    "details": { "firstName": "[REDACTED]", "lastName": "[REDACTED]" },
    "accountCurrency": "GBP",
    "accountReference": { "accountNumber": "[REDACTED]", "sortCode": "[REDACTED]" },
    "accountReferenceType": "UK_ACCOUNT"
  }
}