v1

latestOpenAPI 3.1.02026-07-1451089.2 KB

Create a webhook

post/webhooks

Query parameters

pipelineKeystring

Pipeline key. You must specify either a pipelineKey or a teamKey; this parameter will define if the webhook is pipeline or team-based.

teamKeystring

Team key. You must specify either a pipelineKey or a teamKey; this parameter will define if the webhook is pipeline or team-based.

Request body

eventstring required

For a complete list of events, please check the list above.

targetUrlstring required

The url to which the event will be sent.

Response

200

eventstring

targetUrlstring

pipelineKeystring

userKeystring

keystring

creationDateinteger

lastSavedTimestampinteger

Example response

{
  "event": "TASK_CREATE",
  "targetUrl": "https://hooks.catchme.com/",
  "pipelineKey": "agxzfm1hZaXCgw",
  "userKey": "agxzluZUKDA",
  "key": "gICIxYzv9QoM",
  "creationDate": 1507226274178,
  "lastSavedTimestamp": 1507226274203
}