Skip to content

webhook.test

A test event: when BIRP sends this event, what its data holds and an example of its body.

Version v1.2, updated

On this page

BIRP sends webhook.test to one webhook endpoint, on request. This page says when it is sent and what data holds, with an example of the body.

When it is sent

Sent to one webhook endpoint when the company administrator asks for a test from its page in BIRP, whatever the events it receives. It carries no record.

Data

data holds a fixed message.

Example

Body of webhook.testJSON
{
  "api_version": "v1",
  "data": {
    "message": "Test event sent from BIRP. It carries no record."
  },
  "id": "00000000-0000-4000-8000-000000000117",
  "occurred_at": "2026-09-28T14:05:12.417Z",
  "type": "webhook.test"
}

Related

  • webhook-events
  • register-webhook-endpoint
  • verify-webhook-signatures