Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
Webhooks

Subscribe to webhook

ℹ️

Akahu's webhooks are unusual in that they need to be initialised per user, requiring a new webhook subscription for each event type you wish to receive for each user.

Register a new webhook subscription for the user, allowing your application to receive events on the following webhook types:

  • TOKEN
  • ACCOUNT
  • TRANSACTION
  • PAYMENT
  • TRANSFER

ℹ️

It is a good idea to use the state field to store a unique identifier related to your end user, allowing you to determine on an arrival of a webhook event which user of your application needs to be updated or notified.

For more details about webhooks see:

  • 📖 Webhooks reference
  • 📖 Webhooks events
post/webhooks

Headers

X-Akahu-Idstring required

Your App ID Token.

Content-Typestring

Request body

webhook_typestring

Which types of events you want to receive webhooks for.

statestring

State that will be returned with the webhook payload.

Response

Successful response.

successboolean
item_idstring

Newly created Akahu webhook identifer.

Example response

{
  "success": true,
  "item_id": "hook_1111111111111111111111111"
}