STstreakyc
Webhooks

Create a pipeline webhook

Changed on

Subscribes to a pipeline event. A body scope that conflicts with the URL returns 400.

post/v2/pipelines/{pipelineKey}/webhooks

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v2/pipelines/{pipelineKey}/webhooks
  • Auth
    HTTP bearer

Path parameters

pipelineKeystring required

Request body

event'BOX_CREATE' | 'BOX_PRESENCE_CHANGED' | 'STAGE_CREATE' | 'BOX_NEW_EMAIL_ADDRESS' | 'BOX_EDIT' | 'BOX_CHANGE_STAGE' | 'BOX_CHANGE_PIPELINE' | 'BOX_DELETE' | 'COMMENT_CREATE' | 'TASK_CREATE' | 'TASK_COMPLETE' | 'TASK_DUE' | 'TASK_UPDATED' | 'BOX_NEW_EMAIL_RECEIVED' | 'CONTACT_CREATE' | 'ORG_CREATE' | 'CONTACT_UPDATE' | 'ORG_UPDATE' | 'CONTACT_DELETE' | 'ORG_DELETE' | 'MEETING_CREATE' | 'MEETING_UPDATE' | 'THREAD_ADDED_TO_BOX' | 'THREAD_REMOVED_FROM_BOX' required
targetUrlstring required

Nonempty URL that receives webhook deliveries.

pipelineKeystring nullable

Pipeline to watch. Must match the pipeline in the URL when one is provided.

teamKeystring nullable

Team to watch. Must match the team in the URL when one is provided.

tokenstring nullable

Optional token to send in the webhook delivery header.

Response

OK

keystring required

Key identifying the webhook subscription.

event'BOX_CREATE' | 'BOX_PRESENCE_CHANGED' | 'STAGE_CREATE' | 'BOX_NEW_EMAIL_ADDRESS' | 'BOX_EDIT' | 'BOX_CHANGE_STAGE' | 'BOX_CHANGE_PIPELINE' | 'BOX_DELETE' | 'COMMENT_CREATE' | 'TASK_CREATE' | 'TASK_COMPLETE' | 'TASK_DUE' | 'TASK_UPDATED' | 'BOX_NEW_EMAIL_RECEIVED' | 'CONTACT_CREATE' | 'ORG_CREATE' | 'CONTACT_UPDATE' | 'ORG_UPDATE' | 'CONTACT_DELETE' | 'ORG_DELETE' | 'MEETING_CREATE' | 'MEETING_UPDATE' | 'THREAD_ADDED_TO_BOX' | 'THREAD_REMOVED_FROM_BOX' required
targetUrlstring required

URL that receives webhook deliveries.

pipelineKeystring nullable

Pipeline being watched; omitted for team subscriptions.

teamKeystring nullable

Team being watched; omitted for pipeline subscriptions.

userKeystring required

User who created the subscription.

tokenstring nullable

Optional token sent in the webhook delivery header.

creationDateinteger nullable

When the subscription was created, in epoch milliseconds.

lastSavedTimestampinteger required

When the subscription was last saved, in epoch milliseconds.

Example response

{
  "creationDate": 1646870400000,
  "lastSavedTimestamp": 1646870400000
}

Changes