What are Webhooks?

Overview

As we strive to offer you maximum flexibility in using your Pitchlane videos, we've recently added the capability to attach webhooks to your Pitchlane campaigns. Webhooks serve as a communication bridge between different applications. Specifically for Pitchlane, they enable seamless communication with other apps. If you're interested in integrating Pitchlane with a third-party service, like a sending tool, check out our Integration Guides. Leveraging Pitchlane's integration with Zapier, these guides are designed to help you maximise the utility of Pitchlane in a straightforward and user-friendly manner.

Finding Webhooks

To find the Webhook functionality in Pitchlane navigate to your campaign and select the "Engage" tab. Then select, "Create Webhook".

This is how Webhooks typically work:

1.) An Event Occurs: In Pitchlane this could include: a video being rendered in Pitchlane or even a video being watched by one of your prospects. You can see the full list of events by selecting, "Event".

2.) POST Request: Once you choose the event you want to trigger, Pitchlane can send an HTTP POST request to a URL of your choice. Unsure about what this means? Click here! You'll receive this URL from the application you're integrating with Pitchlane. To set it up, simply paste the URL into the "URL" section of the "Create a New Webhook" window.

3.) Payload: When the event you selected occurs, Pitchlane will send data which relates to the event type. For example, if you select, "video rendered". Here is an example of a Pitchlane POST Request:

{
  "video": {
    "id": "ID Number",
    "shortId": "Short ID Number",
    "title": "Video for [Customer]",
    "createdAt": "2023-08-26T15:24:28.415Z",
    "queuedAt": "2023-08-26T15:36:50.556Z",
    "startedProcessingAt": "2023-08-26T15:37:55.473Z",
    "startedRenderingAt": "2023-08-26T15:40:47.275Z",
    "backgroundRecordedAt": "2023-08-26T15:39:18.462Z",
    "renderedAt": "2023-08-26T15:51:32.900Z",
    "meta": {},
    "variables": {
      "website_0": "https://example.com",
      "first_name": "First Name",
      "company_name": "Company"
    },
    "importId": "example.csv",
    "originalRowIndex": 0,
    "originalUid": "email",
    "campaignId": "pitchlane campaign number",
    "thumbnailUrl": "https://playvideopitchlane.com/thumbnail/renderid.gif",
    "thumbnailStorageUrl": "https://storage.googleapis.com/videos-eu/renderid.gif",
    "thumbnailEmbed": "<div><a target=\"_blank\" href=\"https://playvideopitchlane.com/video/campaignid\"><img style=\"margin:0px;box-sizing:border-box;padding:0px;width:100%;max-width:300px;height:auto\" src=\"https://playvideopitchlane.com/thumbnail/campaignid.gif\" alt=\"Video for Customer\"></a><br /></div>",
    "thumbnailStorageEmbed": "<div><a target=\"_blank\" href=\"https://playvideopitchlane.com/video/example\"><img style=\"margin:0px;box-sizing:border-box;padding:0px;width:100%;max-width:300px;height:auto\" src=\"https://storage.googleapis.com/videos-eu/example.gif\" alt=\"Video for customer\"></a><br /></div>",
    "videoFileUrl": "https://storage.googleapis.com/videos-eu/example.mp4",
    "videoUrl": "https://playvideopitchlane.com/video/example",
    "originalRow": {
      "email": "email@address.com"
    }
  }
}

4.) Receiving Application: The Application that you are trying to connect Pitchlane to using webhooks will process the payload when it receives the post request, as you have configured in the receiving application.

Alternatives

Pitchlane has an integration with a tool called Zapier. Zapier is an online automation tool which allows you to connect Pitchlane to a multitude of your favourite apps! Due to Zapier's user-friendly interface, and the fact that we have created integration guides for a plethora of sending tools, if you are unsure about how to use webhooks, to give Zapier a try!

You can find the guides here - Pitchlane Integration Guides