Skip to main content
POST
/
webhookendpoints
curl --request POST \
     --url https://api.tryaqueduct.com/v1/webhookendpoints \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json'

{
  "id": "web_01FSSVRVGQ7GGB13815DE3F518",
  "url": "https://foo.com/example/endpoint",
  "enabledEvents": [
    [
      "provisioning_start",
      "provisioning_update"
    ]
  ],
  "createdAt": "2022-01-15T15:53:00.000Z",
  "description": "This webhook listens to events from Aqueduct",
  "secret": "This is only included at webhook endpoint creation"
}
curl --request POST \
     --url https://api.tryaqueduct.com/v1/webhookendpoints \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json'

Body

application/json
​
description
string

An optional description of what the webhook is used for.

Example:

"This webhook listens to events from Aqueduct"

​
url
string

The url of the webhook endpoint.

Example:

"https://foo.com/example/endpoint"

​
enabledEvents
string[]

The list of events to enable for this endpoint

Response

Returns the created webhook endpoint

You can configure a webhook endpoint to be notified about events that happen on Aqueduct programmatically.

​
id
string
required
Example:

"web_01FSSVRVGQ7GGB13815DE3F518"

​
url
string
required

The url of the webhook endpoint.

Example:

"https://foo.com/example/endpoint"

​
enabledEvents
string[]
required

The list of events to enable for this endpoint

​
createdAt
string<date>
required

Time at which the object was created.

Example:

"2022-01-15T15:53:00.000Z"

​
description
string

An optional description of what the webhook is used for.

Example:

"This webhook listens to events from Aqueduct"

​
secret
string

A string that is used to verify the webhook. Only returned at creation

Example:

"This is only included at webhook endpoint creation"