STstreakyc
Webhooks

Get a webhook

Changed on

Returns a subscription created by the authenticated user, subject to its team or pipeline permissions.

get/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

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