Sign in

v14

latestOpenAPI 3.0.32026-08-04377889.4 MB
webhooks

Creates a webhook

Creates a webhook

post/v1/webhooks

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

urlstring uri required
eventsstring[] required
projectIdsstring[]

Response

secretstring required

The webhook secret used to sign the payload

eventsstring[] required

The webhooks events

idstring required

The webhook id

urlstring required

A string with the URL of the webhook

ownerIdstring required

The unique ID of the team the webhook belongs to

createdAtnumber required

A number containing the date when the webhook was created in in milliseconds

updatedAtnumber required

A number containing the date when the webhook was updated in in milliseconds

projectIdsstring[]

The ID of the projects the webhook is associated with

Example response

{
  "events": [
    "deployment.created"
  ],
  "id": "account_hook_GflD6EYyo7F4ViYS",
  "url": "https://my-webhook.com",
  "ownerId": "ZspSRT4ljIEEmMHgoDwKWDei",
  "createdAt": 1567024758130,
  "updatedAt": 1567024758130,
  "projectIds": [
    "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB"
  ]
}