STstreakyc
Webhooks

Update a webhook

Changed on

Updates the destination, token or event. Omitted and null fields remain unchanged; the scope cannot change.

post/v2/webhooks/{webHookKey}

Request

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

Path parameters

webHookKeystring 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' nullable

New event; must remain in the same pipeline or team event family.

targetUrlstring nullable

New nonempty URL for webhook deliveries.

tokenstring nullable

New delivery token. An empty string replaces the existing token with an empty value.

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