Skip to main content
POST
TypeScript SDK

Authorizations

Authorization
string
header
required

Use an API key created in the NinjaChat developer console.

Body

application/json
url
string<uri>
required
Maximum string length: 2000
events
enum<string>[]
Minimum array length: 1
Available options:
video.completed,
video.failed,
pipeline.completed,
pipeline.failed,
request.failed,
budget.alert,
balance.low,
balance.exhausted,
credits.added,
auto_recharge.failed,
key.created,
key.revoked,
budget.updated

Response

Webhook created. The signing secret is returned once (used only by generic receivers).

id
string
required
url
string<uri>
required
events
enum<string>[]
required
Available options:
video.completed,
video.failed,
pipeline.completed,
pipeline.failed,
request.failed,
budget.alert,
balance.low,
balance.exhausted,
credits.added,
auto_recharge.failed,
key.created,
key.revoked,
budget.updated
secret
string
required
message
string
required
destination
enum<string>
Available options:
webhook,
discord,
slack