Skip to main content
Requires an API key with full_access scope. All fields are optional. Only include the fields you want to change.

​
Path parameters

​
string
required
The unique identifier of the webhook.

​
Body

​
string
Webhook name. 2 to 100 characters.
​
string
The HTTPS endpoint that will receive webhook deliveries. Must start with https://.
​
string[]
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.deleted
​
string
Webhook status. Either active or paused. Setting to active resets the failure count to 0.

​
Response

​
string
Confirmation message.

​
Errors

400 Bad Request - Validation failed.
Other validation messages include:
  • name must be a string
  • url must be a string starting with https://
  • event_types must be a non-empty array
  • Invalid event type: {type}
  • status must be one of: active, paused
  • At least one field to update is required (name, url, event_types, status)
404 Not Found - Webhook not found.