v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB

Webhooks

Get webhook events

⚠️

Authentication This endpoint requires app-scoped authentication.

Returns a list of webhook events that have been published to your application by Akahu within the start and end time range.

️ ℹ️ Time range defaults to the last 30 days.

For more details about webhooks see:

📖 Webhooks reference
📖 Webhooks events

get/webhook-events

Query parameters

status'SENT' | 'FAILED' | 'RETRY'

Example:SENT

State of the webhook event

startstring date-time

ISO 8601 formatted date

endstring date-time

ISO 8601 formatted date

Headers

X-Akahu-Idstring required

Your App ID Token.

Response

Successful response.

successboolean

Example response

{
  "success": true,
  "items": [
    {
      "_id": "hook_1111111111111111111111111",
      "hook": "hook_1111111111111111111111111",
      "status": "FAILED",
      "created_at": "2020-04-08T23:15:39.917Z",
      "updated_at": "2020-04-08T23:15:39.917Z",
      "last_failed_at": "2020-04-08T23:15:39.917Z",
      "payload": {
        "success": true,
        "webhook_type": "TOKEN"
      }
    }
  ]
}