Skip to main content

Webhook Subscriptions

This section contains 1 subgroups.

List Webhook Subscriptions​

Reporting, Audit & Webhooks / Webhooks / Webhook Subscriptions
GET/webhooks/subscriptions?page=1&limit=10&language=en

Get a paginated list of webhook subscriptions for the current tenant. Requires view:tenant permission.

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request GET "$ONDI_BASE_URL/webhooks/subscriptions?page=1&limit=10&language=en" \2  --header "Authorization: Bearer {{access_token}}"

Query parameters

pageOptional
query string

1

Page number for pagination

limitOptional
query string

10

Number of items per page

languageOptional
query string

en

Preferred language for response messages

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Responses

Success Response200OK
Error - Insufficient Permissions403Forbidden

List User Webhook Subscriptions​

Reporting, Audit & Webhooks / Webhooks / Webhook Subscriptions
GET/webhooks/users/:user_id/subscriptions?page=1&limit=10&language=en

Get a paginated list of webhook subscriptions for a specific user. Requires view:tenant permission.

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request GET "$ONDI_BASE_URL/webhooks/users/:user_id/subscriptions?page=1&limit=10&language=en" \2  --header "Authorization: Bearer {{access_token}}"

Path parameters

user_idRequired
path string

uuid

ID of the user to list webhook subscriptions for

Query parameters

pageOptional
query string

1

Page number for pagination

limitOptional
query string

10

Number of items per page

languageOptional
query string

en

Preferred language for response messages

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Responses

Success Response200OK

Create Webhook Subscription​

Reporting, Audit & Webhooks / Webhooks / Webhook Subscriptions
POST/webhooks/subscriptions?language=en

Create a new webhook subscription for the current tenant. Requires manage:webhooks:tenant permission. Required Fields: - module_id: Identifier for the module generating events (e.g., 'DELIVERY') - webhook_url: HTTPS URL to receive webhook events Optional Fields: - secret_header_name: Name of header to include webhook secret in - secret_header_value: Secret value for webhook authentication - is_active: Whether the subscription is active (default: true)

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request POST "$ONDI_BASE_URL/webhooks/subscriptions?language=en" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "Content-Type: application/json" \4  --header "Content-Type: application/json" \5  --data '{6  "module_id": "DELIVERY",7  "webhook_url": "https://example.com/webhook",8  "secret_header_name": "X-Webhook-Secret",9  "secret_header_value": "your-secret-key-here",10  "is_active": true11}'
Request body
json
1{2  "module_id": "DELIVERY",3  "webhook_url": "https://example.com/webhook",4  "secret_header_name": "X-Webhook-Secret",5  "secret_header_value": "your-secret-key-here",6  "is_active": true7}

Query parameters

languageOptional
query string

en

Preferred language for response messages

Request body fields

module_idExample
string

Example field from the request body.

webhook_urlExample
string

Example field from the request body.

secret_header_nameExample
string

Example field from the request body.

secret_header_valueExample
string

Example field from the request body.

is_activeExample
boolean

Example field from the request body.

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Content-TypeOptional
header string

application/json

Responses

Success Response201Created
Error - Invalid URL400Bad Request
Error - Missing Required Field400Bad Request
Error - Subscription Already Exists400Bad Request

Get Webhook Subscription​

Reporting, Audit & Webhooks / Webhooks / Webhook Subscriptions
GET/webhooks/subscriptions/:subscriptionId?language=en

Get details of a specific webhook subscription by ID. Requires view:tenant permission.

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request GET "$ONDI_BASE_URL/webhooks/subscriptions/:subscriptionId?language=en" \2  --header "Authorization: Bearer {{access_token}}"

Path parameters

subscriptionIdRequired
path string

uuid

ID of the webhook subscription to retrieve

Query parameters

languageOptional
query string

en

Preferred language for response messages

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Responses

Success Response200OK
Error - Subscription Not Found404Not Found

Get User Webhook Subscription​

Reporting, Audit & Webhooks / Webhooks / Webhook Subscriptions
GET/webhooks/users/:user_id/subscriptions/:subscriptionId?language=en

Get details of a specific webhook subscription by ID for a specific user. Requires view:tenant permission.

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request GET "$ONDI_BASE_URL/webhooks/users/:user_id/subscriptions/:subscriptionId?language=en" \2  --header "Authorization: Bearer {{access_token}}"

Path parameters

user_idRequired
path string

uuid

ID of the user

subscriptionIdRequired
path string

uuid

ID of the webhook subscription to retrieve

Query parameters

languageOptional
query string

en

Preferred language for response messages

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Responses

Success Response200OK

Update Webhook Subscription​

Reporting, Audit & Webhooks / Webhooks / Webhook Subscriptions
PUT/webhooks/subscriptions/:subscriptionId?language=en

Update an existing webhook subscription. Requires manage:webhooks:tenant permission. Updatable Fields: - webhook_url: HTTPS URL to receive webhook events - secret_header_name: Name of header to include webhook secret in - secret_header_value: Secret value for webhook authentication - is_active: Whether the subscription is active

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request PUT "$ONDI_BASE_URL/webhooks/subscriptions/:subscriptionId?language=en" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "Content-Type: application/json" \4  --header "Content-Type: application/json" \5  --data '{6  "webhook_url": "https://example.com/updated-webhook",7  "secret_header_name": "X-Webhook-Secret-Updated",8  "secret_header_value": "updated-secret-key",9  "is_active": false10}'
Request body
json
1{2  "webhook_url": "https://example.com/updated-webhook",3  "secret_header_name": "X-Webhook-Secret-Updated",4  "secret_header_value": "updated-secret-key",5  "is_active": false6}

Path parameters

subscriptionIdRequired
path string

uuid

ID of the webhook subscription to update

Query parameters

languageOptional
query string

en

Preferred language for response messages

Request body fields

webhook_urlExample
string

Example field from the request body.

secret_header_nameExample
string

Example field from the request body.

secret_header_valueExample
string

Example field from the request body.

is_activeExample
boolean

Example field from the request body.

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Content-TypeOptional
header string

application/json

Responses

Success Response200OK
Error - Subscription Not Found404Not Found
Error - Invalid URL400Bad Request

Update User Webhook Subscription​

Reporting, Audit & Webhooks / Webhooks / Webhook Subscriptions
PUT/webhooks/users/:user_id/subscriptions/:subscriptionId?language=en

Update an existing webhook subscription for a specific user. Requires manage:webhooks:tenant permission. Updatable Fields: - webhook_url: HTTPS URL to receive webhook events - secret_header_name: Name of header to include webhook secret in - secret_header_value: Secret value for webhook authentication - is_active: Whether the subscription is active

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request PUT "$ONDI_BASE_URL/webhooks/users/:user_id/subscriptions/:subscriptionId?language=en" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "Content-Type: application/json" \4  --header "Content-Type: application/json" \5  --data '{6  "webhook_url": "https://example.com/updated-webhook",7  "secret_header_name": "X-Webhook-Secret-Updated",8  "secret_header_value": "updated-secret-key",9  "is_active": false10}'
Request body
json
1{2  "webhook_url": "https://example.com/updated-webhook",3  "secret_header_name": "X-Webhook-Secret-Updated",4  "secret_header_value": "updated-secret-key",5  "is_active": false6}

Path parameters

user_idRequired
path string

uuid

ID of the user

subscriptionIdRequired
path string

uuid

ID of the webhook subscription to update

Query parameters

languageOptional
query string

en

Preferred language for response messages

Request body fields

webhook_urlExample
string

Example field from the request body.

secret_header_nameExample
string

Example field from the request body.

secret_header_valueExample
string

Example field from the request body.

is_activeExample
boolean

Example field from the request body.

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Content-TypeOptional
header string

application/json

Responses

Success Response200OK

Delete Webhook Subscription​

Reporting, Audit & Webhooks / Webhooks / Webhook Subscriptions
DELETE/webhooks/subscriptions/:subscriptionId?language=en

Delete a webhook subscription by ID. Requires manage:webhooks:tenant permission.

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request DELETE "$ONDI_BASE_URL/webhooks/subscriptions/:subscriptionId?language=en" \2  --header "Authorization: Bearer {{access_token}}"

Path parameters

subscriptionIdRequired
path string

uuid

ID of the webhook subscription to delete

Query parameters

languageOptional
query string

en

Preferred language for response messages

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Responses

Success Response200OK
Error - Subscription Not Found404Not Found

Delete User Webhook Subscription​

Reporting, Audit & Webhooks / Webhooks / Webhook Subscriptions
DELETE/webhooks/users/:user_id/subscriptions/:subscriptionId?language=en

Delete a webhook subscription by ID for a specific user. Requires manage:webhooks:tenant permission.

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request DELETE "$ONDI_BASE_URL/webhooks/users/:user_id/subscriptions/:subscriptionId?language=en" \2  --header "Authorization: Bearer {{access_token}}"

Path parameters

user_idRequired
path string

uuid

ID of the user

subscriptionIdRequired
path string

uuid

ID of the webhook subscription to delete

Query parameters

languageOptional
query string

en

Preferred language for response messages

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Responses

Success Response200OK