API ReferenceWeb-Hooks

Read Configuration

Backend-only API-key call. This reads the current application-scoped web-hook callback configuration for the tenant/application associated with the API key.

Authentication

AuthorizationBearer

Send Authorization: Bearer <PLATFORM_API_KEY> from a trusted back-end.

Path parameters

tenantIDstringRequiredformat: "uuid"
Tenant ID associated with the API key.
applicationIDstringRequiredformat: "uuid"
Application ID associated with the API key.

Response

Current web-hook configuration for the application.

tenant_idstringformat: "uuid"
application_idstringformat: "uuid"
webhook_enabledboolean
webhook_urlstring or nullformat: "uri"

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error