### Example Payload 1 - VIDEO_STARTED event from CSV video Source: https://docs.pitchlane.com/guide/webhook-schemas Webhook payload triggered by VIDEO_STARTED for a video created from the example CSV. Contains a video object with metadata such as event, eventAt, and viewedAt. ```json { "video": { "_id": "qHJqGpTe0qxm_3kqXHENL", "shortId": "PtIpJKUD0lRp", "title": "Video for Ryane", "campaignId": "vDMeo5EmtGBIP7NMqW5RF", "meta": {}, // legacy "storagePaths": { "video": "hBPGjWK0Ld9FhXZvxeqSx.mp4", "video_mp4": "hBPGjWK0Ld9FhXZvxeqSx.mp4", "thumbnail": "s2ELq_HDs6udzoVhPuBM1.gif", "thumbnail_png": "YXW6Ie9mgdWQenC7c1YFz.png" }, "variables": { "website_0": "https://pitchlane.com", "first_name": "Ryane" }, "importId": "example.csv-2024-08-23-16-03", "createdAt": "2024-08-23T15:03:57.613Z", "userId": "auth0|649c36d5e23299e4e136598", "originalRow": { "first_name": "Ryane", "last_name": "Tully", "website": "https://pitchlane.com", "email": "ryane@pitchlane.io", "company": "Pitchlane" }, "originalRowIndex": 0, "originalUid": "ryane@pitchlane.io", "importSource": "CSV", "queuedAt": "2024-08-23T15:03:58.005Z", "startedProcessingAt": "2024-08-23T15:04:46.644Z", "backgroundRecordedAt": "2024-08-23T15:05:21.436Z", "startedRenderingAt": "2024-08-23T15:06:51.365Z", "isTestVideoQuality": true, "testVideoRenderedAt": "2024-08-23T15:07:10.690Z", "renderedAt": "2024-08-23T15:07:10.885Z", "campaignName": "Some Campaign Name" }, "viewedAt": "2024-08-23T15:12:49.865Z", "eventAt": "2024-08-23T15:12:49.865Z", "event": "VIDEO_STARTED" } ``` -------------------------------- ### GET /campaigns Source: https://docs.pitchlane.com/reference Lists all your campaigns. Returns a list of campaign summaries. ```APIDOC ## GET /campaigns ### Description Lists all your campaigns. Returns a list of campaign summaries. ### Method GET ### Endpoint /campaigns ### Request Example ``` curl --request GET \ --url https://api.pitchlane.com/api/public/v1/campaigns \ --header 'X-Api-Key: YOUR_TOKEN' ``` ### Response #### Success Response (200) Returns a list of campaign summaries. #### Response Example ``` [ { "id": "o6duFik0_UNSUGPCn1LTm", "name": "…", "createdAt": "2026-09-12T03:12:01.054Z", "variableSchema": { "ANY_ADDITIONAL_PROPERTY": { "label": "…", "required": true, "validator": { "type": null, "domain": null } } }, "examplePayload": { "ANY_ADDITIONAL_PROPERTY": "anything" } } ] ``` ``` -------------------------------- ### GET /campaigns/{campaignId}/schemas Source: https://docs.pitchlane.com/reference Retrieves the variable schema and lead schema mapping for a specific campaign. Returns both variable and lead schema mappings along with their example payloads. ```APIDOC ## GET /campaigns/{campaignId}/schemas ### Description Retrieves the variable schema and lead schema mapping for a specific campaign. Returns both variable and lead schema mappings along with their example payloads. ### Method GET ### Endpoint /campaigns/{campaignId}/schemas ### Parameters #### Path Parameters - **campaignId** (string) - Required - The unique identifier of the campaign for which the schema is being retrieved. ### Request Example ``` curl --request GET \ --url https://api.pitchlane.com/api/public/v1/campaigns/__CAMPAIGNID__/schemas \ --header 'X-Api-Key: YOUR_TOKEN' ``` ### Response #### Success Response (200) Returns both variable and lead schema mappings along with their example payloads. #### Response Example ``` { "variableSchema": { "ANY_ADDITIONAL_PROPERTY": { "label": "…", "required": true, "validator": { "type": "url", "domain": "…" } } }, "exampleVariableSchemaPayload": { "ANY_ADDITIONAL_PROPERTY": "anything" }, "leadSchemaMapping": { "ANY_ADDITIONAL_PROPERTY": "anything" }, "exampleLeadSchemaMappingPayload": { "ANY_ADDITIONAL_PROPERTY": "anything" } } ``` #### Error Response (404) Campaign not found. ``` -------------------------------- ### Example Payload 2 - VIDEO_CREATED event from manual video Source: https://docs.pitchlane.com/guide/webhook-schemas Webhook payload triggered by VIDEO_CREATED for a manually created video. Contains both video and rawVideo objects, with event and eventAt metadata. ```json { "video": { "id": "XEKcAejz6cWRlUOtn0SGw", "shortId": "OFcf-PfxLI9q", "title": "Video for John", "createdAt": "2024-08-28T11:47:30.172Z", "meta": {}, // legacy "variables": { "first_name": "John", "company_name": "John SEO", "email": "john@johnseo.com", "website_0": "https://google.com" }, "importId": "manual import", "campaignId": "5jTuhVapNA0uDohhB00xl", "campaignName": "Example Campaign", "thumbnailUrl": null, "thumbnailStorageUrl": null, "thumbnailUrlPNG": null, "thumbnailStorageUrlPNG": null, "thumbnailEmbed": null, "thumbnailStorageEmbed": null, "videoFileUrl": null, "videoUrl": null, "originalRow": {} }, "rawVideo": { "_id": "XEKcAejz6cWRlUOtn0SGw", "shortId": "OFcf-PfxLI9q", "importId": "manual import", "campaignId": "5jTuhVapNA0uDohhB00xl", "title": "Video for John", "meta": {}, // legacy "variables": { "first_name": "John", "company_name": "John SEO", "email": "john@johnseo.com", "website_0": "https://google.com" }, "createdAt": "2024-08-28T11:47:30.172Z", "storagePaths": {}, "userId": "google-oauth2|105725975687048448237", "originalRow": {}, "importSource": "MANUAL" }, "event": "VIDEO_CREATED", "eventAt": "2024-08-28T11:47:30.282Z" } ``` -------------------------------- ### GET /campaigns/{campaignId}/lead-schema-mapping Source: https://docs.pitchlane.com/reference Retrieves the lead schema mapping associated with a specific campaign. The campaignId path parameter is required to identify the campaign. ```APIDOC ## GET /campaigns/{campaignId}/lead-schema-mapping ### Description Retrieves the lead schema mapping associated with a specific campaign. ### Method GET ### Endpoint /campaigns/{campaignId}/lead-schema-mapping ### Parameters #### Path Parameters - **campaignId** (string) - Required - The unique identifier of the campaign for which the schema is being retrieved ### Request Example ``` curl --request GET \ --url https://api.pitchlane.com/api/public/v1/campaigns/__CAMPAIGNID__/lead-schema-mapping \ --header 'X-Api-Key: YOUR_TOKEN' ``` ### Response #### Success Response (200) Returns the lead schema mapping associated with the campaign. #### Response Example ``` { "leadSchemaMapping": {}, "examplePayload": { "ANY_ADDITIONAL_PROPERTY": "anything" } } ``` #### Error Response (404) Campaign not found. ``` -------------------------------- ### GET /campaigns/{campaignId}/schema Source: https://docs.pitchlane.com/reference Retrieves the variable schema for a specific campaign. Returns the variable schema associated with the campaign. ```APIDOC ## GET /campaigns/{campaignId}/schema ### Description Retrieves the variable schema for a specific campaign. Returns the variable schema associated with the campaign. ### Method GET ### Endpoint /campaigns/{campaignId}/schema ### Parameters #### Path Parameters - **campaignId** (string) - Required - The unique identifier of the campaign for which the schema is being retrieved. ### Request Example ``` curl --request GET \ --url https://api.pitchlane.com/api/public/v1/campaigns/__CAMPAIGNID__/schema \ --header 'X-Api-Key: YOUR_TOKEN' ``` ### Response #### Success Response (200) Returns the variable schema associated with the campaign. #### Response Example ``` { "variableSchema": { "ANY_ADDITIONAL_PROPERTY": { "label": "…", "required": true, "validator": { "type": "url", "domain": "…" } } }, "examplePayload": { "ANY_ADDITIONAL_PROPERTY": "anything" } } ``` #### Error Response (404) Campaign not found. ``` -------------------------------- ### List all campaigns via cURL Source: https://docs.pitchlane.com/reference Retrieves a list of all campaign summaries for the authenticated user. ```shell curl --request GET \ --url https://api.pitchlane.com/api/public/v1/campaigns \ --header 'X-Api-Key: YOUR_TOKEN' ``` -------------------------------- ### Retrieve lead schema mapping via cURL Source: https://docs.pitchlane.com/reference Use this request to fetch the lead schema mapping for a specific campaign. Replace __CAMPAIGNID__ with the actual campaign identifier and YOUR_TOKEN with your API key. ```bash curl --request GET \ --url https://api.pitchlane.com/api/public/v1/campaigns/__CAMPAIGNID__/lead-schema-mapping \ --header 'X-Api-Key: YOUR_TOKEN' ``` -------------------------------- ### Retrieve campaign schema and lead mapping via cURL Source: https://docs.pitchlane.com/reference Fetches both variable and lead schema mappings for a specific campaign using the campaignId. ```shell curl --request GET \ --url https://api.pitchlane.com/api/public/v1/campaigns/__CAMPAIGNID__/schemas \ --header 'X-Api-Key: YOUR_TOKEN' ``` -------------------------------- ### List campaigns response schema Source: https://docs.pitchlane.com/reference The JSON structure returned when listing all campaign summaries. ```json [ { "id": "o6duFik0_UNSUGPCn1LTm", "name": "…", "createdAt": "2026-09-12T03:12:01.054Z", "variableSchema": { "ANY_ADDITIONAL_PROPERTY": { "label": "…", "required": true, "validator": { "type": null, "domain": null } } }, "examplePayload": { "ANY_ADDITIONAL_PROPERTY": "anything" } } ] ``` -------------------------------- ### Campaign schema and lead mapping response schema Source: https://docs.pitchlane.com/reference The JSON structure returned when successfully retrieving variable and lead schema mappings. ```json { "variableSchema": { "ANY_ADDITIONAL_PROPERTY": { "label": "…", "required": true, "validator": { "type": "url", "domain": "…" } } }, "exampleVariableSchemaPayload": { "ANY_ADDITIONAL_PROPERTY": "anything" }, "leadSchemaMapping": { "ANY_ADDITIONAL_PROPERTY": "anything" }, "exampleLeadSchemaMappingPayload": { "ANY_ADDITIONAL_PROPERTY": "anything" } } ``` -------------------------------- ### Lead schema mapping response schema Source: https://docs.pitchlane.com/reference The structure of the JSON response returned by the lead schema mapping endpoint. ```json { "leadSchemaMapping": {}, "examplePayload": { "ANY_ADDITIONAL_PROPERTY": "anything" } } ``` -------------------------------- ### Retrieve campaign variable schema via cURL Source: https://docs.pitchlane.com/reference Fetches the variable schema associated with a specific campaign using the campaignId. ```shell curl --request GET \ --url https://api.pitchlane.com/api/public/v1/campaigns/__CAMPAIGNID__/schema \ --header 'X-Api-Key: YOUR_TOKEN' ``` -------------------------------- ### Campaign variable schema response schema Source: https://docs.pitchlane.com/reference The JSON structure returned when successfully retrieving the variable schema for a campaign. ```json { "variableSchema": { "ANY_ADDITIONAL_PROPERTY": { "label": "…", "required": true, "validator": { "type": "url", "domain": "…" } } }, "examplePayload": { "ANY_ADDITIONAL_PROPERTY": "anything" } } ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.