Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

An API key is a token that you provide when making API calls. Read more about how to secure your project.

Include the API key to the Authorization header, for instance:

If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:

Body

application/json

Configuration for a webhook endpoint

url
string | null

URL endpoint to call when tasks complete.

Example:

"https://your.site/on-tasks-completed"

headers
object | null

HTTP headers to include in webhook requests.

Example:

Response

Webhook created successfully.

Webhook object with metadata and redacted authorization headers.

uuid
string<uuid>
required

Unique identifier of the webhook.

isEditable
boolean
required

Whether the webhook can be edited.

url
string | null

URL endpoint to call when tasks complete.

Example:

"https://your.site/on-tasks-completed"

headers
object | null

HTTP headers to include in webhook requests.

Example: