Skip to main content
POST
Creates a new Webhook Configuration

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
webhookName
string
required

The name of the webhook configuration.

webhookUrl
string<uri>
required

The URL to which the webhook notifications will be sent.

eventType
enum<string>[]
required

The list of event types that will trigger the webhook notification.

Available options:
JOB_DELIVER,
JOB_UPDATE,
PROJECT_DELIVER,
PROJECT_UPDATE,
INSTANT_TRANSLATE_COMPLETED,
INSTANT_TRANSLATE_FAILED

Response

Returns the newly created webhook configuration.

id
integer
required

The unique identifier for the webhook configuration.

Example:

12345

webhookName
string
required

The name of the webhook configuration.

webhookUrl
string<uri>
required

The URL to which the webhook notifications will be sent.

eventType
enum<string>[]
required

The list of event types that will trigger the webhook notification.

Available options:
JOB_DELIVER,
JOB_UPDATE,
PROJECT_DELIVER,
PROJECT_UPDATE,
INSTANT_TRANSLATE_COMPLETED,
INSTANT_TRANSLATE_FAILED