Skip to main content
POST
/
webhooks
Create a webhook
curl --request POST \
  --url https://api.cloudglue.dev/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "endpoint": "<string>",
  "subscribed_events": []
}
'
{
  "id": "<string>",
  "created_at": 123,
  "webhook_secret": "<string>",
  "endpoint": "<string>",
  "active": true,
  "subscribed_events": [],
  "description": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Webhook creation parameters

​
description
string

Description of the webhook

​
endpoint
string

URL of the webhook endpoint

​
subscribed_events
enum<string>[]

Events that the webhook is subscribed to

Webhook events that can be subscribed to

Available options:
describe.job.processing,
describe.job.completed,
describe.job.failed,
extract.job.processing,
extract.job.completed,
extract.job.failed,
file.job.processing,
file.job.completed,
file.job.failed,
file.job.deleted,
collection.file.job.processing,
collection.file.job.completed,
collection.file.job.failed,
collection.file.job.deleted,
segment.job.processing,
segment.job.completed,
segment.job.failed

Response

Webhook created successfully

​
id
string
required

Unique identifier for the webhook

​
object
enum<string>
required

Object type, always 'webhook'

Available options:
webhook
​
created_at
integer
required

Unix timestamp in milliseconds when the webhook was created

​
webhook_secret
string
required

Secret used to verify the webhook request

​
endpoint
string
required

URL of the webhook endpoint

​
active
boolean
required

Whether the webhook is active

​
subscribed_events
enum<string>[]
required

Events that the webhook is subscribed to

Webhook events that can be subscribed to

Available options:
describe.job.processing,
describe.job.completed,
describe.job.failed,
extract.job.processing,
extract.job.completed,
extract.job.failed,
file.job.processing,
file.job.completed,
file.job.failed,
file.job.deleted,
collection.file.job.processing,
collection.file.job.completed,
collection.file.job.failed,
collection.file.job.deleted,
segment.job.processing,
segment.job.completed,
segment.job.failed
​
description
string

Description of the webhook