Lead Created

Description

This event is triggered when a new lead is created in the scanleads system. If the lead is already in our system and signs up to a new lead list this event will not be triggered. A lead is considered to be already part of the system, if a lead entry with the same email address can be found in the database.

Payload Structure

type: string

Type of the event, always "lead_created".

version: string

Version of the webhook payload.

retry_count: number

Number of times the webhook has been retried.

trigger_time: string

Time when the event was triggered.

current_time: string

Current time when the webhook is sent.

data: Lead

Data related to the lead. See Lead Object.

Example Payload

{
  "type": "lead_created",
  "version": "1.0",
  "retry_count": 3,
  "trigger_time": "2023-10-01T12:00:00Z",
  "current_time": "2023-10-01T12:20:00Z",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "example@example.com",
    "lists": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Main Newsletter",
        "status": "is_signed_up",
        "meta": {
          "resource-name": "newsletter-1"
        }
      },
      {
        "id": "223e4567-e89b-12d3-a456-426614174000",
        "name": "Raffle",
        "status": "is_verified",
        "meta": {
          "resource-name": "main-raffle"
        }
      }
    ],
    "personal_data": {
      "email": "example@example.com",
      "salutation": "Herr",
      "title": "Dr.",
      "first_name": "Max",
      "last_name": "Mustermann",
      "birthdate": "1968-04-19",
      "phone": "+49 030 3994744",
      "mobile": "+49 0178 0178 0178",
      "address_line_1": "Feldmarkweg 50",
      "city": "Berlin",
      "country": "deutschland",
    },
    "consents": [
      {
        "id": "string",
        "type": "checkbox",
        "name": "Newsletter Wanted",
        "status": "active",

        "meta": {
          "key": "value"
        }
      },
      {
        "id": "string",
        "type": "external",
        "name": "Newsletter Double Opt-In",
        "status": "requested",

        "meta": {
          "key": "value"
        }
      }
    ],
    "meta": {
      "campaign_id": "1234abcd"
    },
    "delete_lead_url": "https://scanly.net/[...]"
  },
  "meta": {
    "custom_key": "some webhook handler specific data"
  }
}