Webhooks
Events

Events

Below is a list of events you can subscribe to, each with a description and its payload structure.

All dates are in UTC using ISO 8601 (opens in a new tab) format.

Funnel

  • event: The event type.
  • funnel: An object containing the details of the funnel:
    • id: The unique identifier of the funnel.
    • name: The name of the funnel.
    • assignedDomain: The default domain assigned to the funnel.
    • customDomain: An optional custom domain assigned to the funnel.
    • funnelSteps: The number of steps in the funnel.
    • isActive: Whether the funnel is currently active.
    • createdAt: The date and time when the funnel was created (ISO 8601 format).

funnel.created - A new funnel has been created.

{
    "event": "funnel.created",
    "funnel": {
        "id": "6a09cf63-1245-4aa0-a122-9a86d515917e",
        "name": "Sample Funnel",
        "assignedDomain": "example.sites.captino.io",
        "customDomain": "example.com",
        "funnelSteps": 5,
        "isActive": true,
        "createdAt": "2024-11-07T15:30:00Z"
    }
}

funnel.updated - A funnel has been updated.

{
    "event": "funnel.updated",
    "funnel": {
        "id": "6a09cf63-1245-4aa0-a122-9a86d515917e",
        "name": "Sample Funnel",
        "assignedDomain": "example.sites.captino.io",
        "customDomain": "example.com",
        "funnelSteps": 5,
        "isActive": true,
        "createdAt": "2024-11-07T15:30:00Z"
    }
}

funnel.deleted - A funnel has been deleted.

{
    "event": "funnel.deleted",
    "funnel": {
        "id": "6a09cf63-1245-4aa0-a122-9a86d515917e",
        "name": "Sample Funnel",
        "assignedDomain": "example.sites.captino.io",
        "customDomain": "example.com",
        "funnelSteps": 5,
        "isActive": true,
        "createdAt": "2024-11-07T15:30:00Z"
    }
}

Contact

  • event: The event type.
  • contact: An object containing the details of the contact:
    • id: The unique identifier of the contact.
    • name: An optional name of the contact.
    • email: An optional email address of the contact.
    • phone: An optional phone number of the contact.
    • note: Additional note about the contact.
    • createdAt: The date and time when the contact was created (ISO 8601 format).

contact.created - A new contact has been created.

{
    "event": "contact.created",
    "contact": {
        "id": "b5cad7df-1b2e-4ce9-9eb9-8db777bff5a3",
        "name": "John Doe",
        "email": "[email protected]",
        "phone": "+1234567890",
        "note": "Important contact for business inquiries.",
        "createdAt": "2024-11-07T10:30:00Z"
    }
}

contact.updated - A contact has been updated.

{
    "event": "contact.updated",
    "contact": {
        "id": "b5cad7df-1b2e-4ce9-9eb9-8db777bff5a3",
        "name": "John Doe",
        "email": "[email protected]",
        "phone": "+1234567890",
        "note": "Important contact for business inquiries.",
        "createdAt": "2024-11-07T10:30:00Z"
    }
}
Getting StartedSecurity