Webhooks

Delete a campaign-specific webhook subscription.

Delete a webhook subscription. If the webhook is associated with a campaign, the campaignId must be provided. If the webhook is not associated with a campaign, the campaignId must be omitted, and the endpoint /webhooks must be used instead.

delete/campaigns/{campaignId}/webhooks

Request

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

Path parameters

campaignIdstring

The unique identifier of the campaign.

Query parameters

webhookUrlstring required

The URL of the webhook to be deleted.

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' required

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 deleted.

Changes

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