Skip to main content
PATCH
Update a webhook endpoint.

Authorizations

Authorization
string
header
required

OAuth 2.0 client_credentials grant via Keycloak service account. Clients are provisioned per IntegrationOrganization in the nt24-idp realm.

Headers

Idempotency-Key
string
required

Client-generated unique key (UUID recommended) for this write operation. Identical key + identical body within 24h returns the cached response. Identical key + different body returns 422.

Required string length: 1 - 255

Path Parameters

id
string
required

Body

application/json
url
string<uri>
events
string[]

Event type or segment wildcard (compliance.*, kyc.*, self_service_invitation.*). Root * is not supported.

partnerIds
string<uuid>[]
status
enum<string>
Available options:
ACTIVE,
PAUSED,
DISABLED

Response

Updated

id
string
required
url
string<uri>
required
events
string[]
required

Event type or segment wildcard (compliance.*, kyc.*, self_service_invitation.*). Root * is not supported.

status
enum<string>
required
Available options:
ACTIVE,
PAUSED,
DISABLED
createdAt
string<date-time>
required
partnerIds
string<uuid>[]
secret
string

Signing secret — returned only on the create response. Not included on GET / list.

updatedAt
string<date-time>