Skip to main content
POST
/
webhooks
Register a webhook endpoint.
curl --request POST \
  --url https://api.novatrade24.com/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "partnerIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "secret": "<string>"
}
'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "status": "ACTIVE",
  "createdAt": "2023-11-07T05:31:56Z",
  "partnerIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "secret": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

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

Body

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

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

​
partnerIds
string<uuid>[]

Optional filter — if set, only events for these partners fire on this endpoint. Omit for all authorized partners.

​
secret
string

Optional provided secret. If omitted, server generates.

Response

Registered. Secret is shown once in the response.

​
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>