POST
/
webhooks
curl --request POST \
  --url https://api.argil.ai/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "callbackUrl": "<string>",
  "events": [
    "AVATAR_TRAINING_SUCCESS"
  ]
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "callbackUrl": "<string>",
  "events": [
    "AVATAR_TRAINING_SUCCESS"
  ],
  "createAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "lastTriggeredAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

API key to be included in the x-api-key header

Body

application/json
​
callbackUrl
string
required

URL to which the webhook will send POST requests.

​
events
enum<string>[]
required

List of events the webhook is subscribing to.

Available options:
AVATAR_TRAINING_SUCCESS,
AVATAR_TRAINING_FAILED,
VIDEO_GENERATION_SUCCESS,
VIDEO_GENERATION_FAILED

Response

201
application/json
Successfully created webhook
​
id
string
​
callbackUrl
string
​
events
enum<string>[]

List of events the webhook is subscribing to.

Available options:
AVATAR_TRAINING_SUCCESS,
AVATAR_TRAINING_FAILED,
VIDEO_GENERATION_SUCCESS,
VIDEO_GENERATION_FAILED
​
createAt
string
​
updatedAt
string
​
lastTriggeredAt
string

Was this page helpful?

Suggest editsRaise issue
/webhooks/webhooks/{id}