Webhooks

Create a webhook subscription.

Notify the specified URL when a video event occurs. If a campaignId is provided, the webhook will only be triggered by events in that campaign. If no campaignId is provided, the webhook will be triggered by events in any campaign.

post/webhooks

Request

  • Base URL: https://api.pitchlane.com/api/public/v1
  • URL: https://api.pitchlane.com/api/public/v1/webhooks
  • Auth: API key in header X-API-Key

Request body

webhookUrlstring

The URL to send the webhook to when the event occurs.

campaignIdstring

The unique identifier of the campaign.

trigger'VIDEO_RENDERED' | 'VIDEO_CREATED' | 'VIDEO_VIEWED' | 'VIDEO_FIRST_VIEWED' | 'VIDEO_STARTED' | 'VIDEO_FIRST_STARTED' | 'VIDEO_FINISHED' | 'VIDEO_FIRST_FINISHED' | 'VIDEO_RENDERED_FULLY' | 'VIDEO_UNRENDERABLE'

The video event that will trigger the webhook. VIDEO_RENDERED_FULLY is for when all optimisations for the video have been made, however you probably don't need this webhook; you should use VIDEO_RENDERED instead. VIDEO_UNRENDERABLE is triggered when a video cannot be rendered - either due to the website or lead being invalid or our bot unable to access it. Not all errors trigger this webhook - Unexpected/Internal Errors do not, so they can be fixed and retried by our team.

Response

The webhook was successfully created.

trigger'VIDEO_RENDERED' | 'VIDEO_CREATED' | 'VIDEO_VIEWED' | 'VIDEO_FIRST_VIEWED' | 'VIDEO_STARTED' | 'VIDEO_FIRST_STARTED' | 'VIDEO_FINISHED' | 'VIDEO_FIRST_FINISHED' | 'VIDEO_RENDERED_FULLY' | 'VIDEO_UNRENDERABLE'

The video event that will trigger the webhook. VIDEO_RENDERED_FULLY is for when all optimisations for the video have been made, however you probably don't need this webhook; you should use VIDEO_RENDERED instead. VIDEO_UNRENDERABLE is triggered when a video cannot be rendered - either due to the website or lead being invalid or our bot unable to access it. Not all errors trigger this webhook - Unexpected/Internal Errors do not, so they can be fixed and retried by our team.

webhookUrlstring

The URL the webhook will be sent to when the trigger occurs.

idstring

The ID of the webhook created.

userIdstring

The unique identifier of the user.

createdAtstring

The date and time the webhook was created.

Example response

{
  "id": "DHFG2C09n_3qrsSymZjjm"
}

Changes

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