WebHook

Creates a new web hook subscription

Sample request:

POST: api/web-hook/subscribe
{
   "source": "zapier",
   "eventType": "task_completed",
   "targetUrl": "https://example.com/hooks/123456789",
   "templateKey": null,
   "taskKey": "50d58518-e049-4474-84c7-036236e52923",
   "taskContentKey": null
}

For task_completed the scope is determined by which key you supply:

  • taskKey: fires only when that specific task is completed
  • templateKey: fires when any task in any checklist of that template is completed
  • (no key): fires when any task in your team is completed
post/api/web-hook/subscribe

Request

  • Base URL: https://app.checkflow.io (the document declares no server; this is the origin it was published from)
  • URL: https://app.checkflow.io/api/web-hook/subscribe
  • Auth: none declared

Query parameters

sourcestring

The source of your web hook

eventTypestring

The type of web hook event. Can be one of the following: new_checklist, task_completed, file_uploaded, data_set.record.created, data_set.record.updated, data_set.record.deleted

targetUrlstring

The URL that the web hook will post the JSON to when the event occurs

templateKeystring

The key for the targeted template (optional - depending on event)

taskKeystring

The key for the targeted task (optional - depending on event)

taskContentKeystring

The key for the targeted task content (optional - depending on event)

Headers

X-API-VERSIONstring

The requested API version

X-API-KEYunknown

API Key

Response

Returns the newly created subscription

Changes

No recorded changes to this operation across all 1 revision of this API.