Webhooks
Create Webhook
Create a new webhook subscription in your workspace.
Requires an API key with
Other validation messages include:
full_access scope.
Creates a webhook that will receive HTTP POST requests whenever the specified events occur in your workspace. The response includes a secret that you should store safely for verifying webhook signatures. The secret is only shown once.
Body
string
required
Webhook name. 2 to 100 characters.
string
required
The HTTPS endpoint that will receive webhook deliveries. Must start with
https://.string[]
required
List of event types to subscribe to. Must include at least one of:
project.created, project.updated, project.deleted, job.created, job.updated, job.deleted, job_type.created, job_type.deletedResponse
string
The unique identifier of the newly created webhook.
string
Webhook name.
string
The delivery URL.
string[]
Subscribed event types.
string
Webhook status. Always
active for new webhooks.string
The webhook signing secret, prefixed with
dbwhsec_. Use this to verify delivery signatures.number
Unix timestamp (milliseconds) when the webhook was created.
Errors
400 Bad Request - Validation failed.name must be between 2 and 100 charactersurl is requiredurl must start with https://event_types is required and must include at least one of: project.created, ...Invalid event type: {type}