/webhook/

post deprecated

http://sync-dev.bkbn.com/webhook/

Deprecated: use PUT /v1/webhooks instead. Sunset: 2026-09-10. Creates or updates a webhook configuration for the authenticated client. If a webhook already exists, it will be updated with the new settings. Supports various authentication methods including API keys, bearer tokens, and custom headers. The webhook URL must be accessible and respond to HTTP requests.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Configuration for the callback endpoint that receives event notifications.

url

uri

required

The URL where webhook events will be sent.

method

string

enum

Defaults to GET

HTTP method BKBN uses when calling your endpoint.

Allowed:

enabled

boolean

Defaults to true

Whether the webhook is enabled and will receive events.

authType

string

enum

Defaults to NONE

Authentication BKBN applies when calling your endpoint. NONE = no auth; HEADER = custom header (authHeaderName, default X-API-Key) set to the secret; QUERY_PARAMETER = secret appended as query param (authParameterName); BEARER_TOKEN = Authorization: Bearer {secret}.

Allowed:

authSecret

string

Authentication secret/token. Write-only; never returned. Omit on update to keep the current value.

authHeaderName

string

Header name to use when authType is HEADER (defaults to X-API-Key if omitted).

authParameterName

string

Query parameter name to use when authType is QUERY_PARAMETER.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200OK