Send an Authorization header with webhook events
If your webhook endpoint sits behind authentication, you can now give us an Authorization header value to send with every event.
Set the optional authorizationHeader field on CreateWebhookInput when calling createWebhookSubscription.
- Sent unchanged: the value is sent, exactly as you provide it, as the
Authorizationheader on every delivery. For exampleBearer <token>orBasic <credentials>. - HTTPS only: the subscription’s endpoint must use
https. - Write-only: the value can’t be read back from the API once it is set, so keep your own copy.
- It’s optional: if you leave it out, events are delivered without an
Authorizationheader.
The authorizationHeader works alongside the x-faml-signature header, it doesn’t replace it. We still recommend verifying the signature on every event, as described in the Webhooks Security documentation.
mutation createWebhookSubscription($input: CreateWebhookInput!) {
createWebhookSubscription(input: $input) {
... on WebhookSubscription {
id
endpoint
verificationKey
}
... on ValidationErrors {
errors { message }
}
}
}
{
"input": {
"endpoint": "https://integrations.example.com/first-aml/webhooks",
"eventTypes": ["CASE_STATUS_UPDATED"],
"failureEmail": "integrations@example.com",
"targets": [
{ "organizationKey": "3f2b8c1e9a4d4e7f8b6c5d4e3f2a1b0c" }
],
"authorizationHeader": "Bearer your-endpoint-token"
}
}
See the Subscribe to webhook events example for a full request and response.