Skip to content

Event Integrations

Manage third-party integrations for calendar events. Integrations allow you to connect events with external services like email marketing platforms.

List Event Integrations

Retrieve all integrations configured for an event.

Endpoint

http
GET /calendars/{id}/events/{event_id}/integrations

URL Parameters

ParameterTypeRequiredDescription
idintegerYesThe calendar ID
event_idintegerYesThe event ID

Response

Returns integration feeds and available integrations.

json
{
    "feeds": [],
    "available_integrations": [],
    "smart_codes": {
        "texts": {
            "guest": {
                "title": "Attendee Data",
                "key": "guest",
                "shortcodes": {
                    "{{guest.first_name}}": "Guest First Name",
                    "{{guest.last_name}}": "Guest Last Name",
                    "{{guest.full_name}}": "Guest Full Name",
                    "{{guest.email}}": "Guest Email"
                }
            },
            "booking": {
                "title": "Booking Data",
                "key": "booking",
                "shortcodes": {
                    "{{booking.event_name}}": "Event Name",
                    "{{booking.description}}": "Event Description"
                }
            }
        }
    }
}

Get Single Integration

Retrieve details for a specific integration.

Endpoint

http
GET /calendars/{id}/events/{event_id}/integrations/{integration_id}

URL Parameters

ParameterTypeRequiredDescription
idintegerYesThe calendar ID
event_idintegerYesThe event ID
integration_idintegerYesThe integration ID

Response

Returns integration configuration details.

Create/Update Integration

Create or update an integration for an event.

Endpoint

http
POST /calendars/{id}/events/{event_id}/integrations/{integration_id}

URL Parameters

ParameterTypeRequiredDescription
idintegerYesThe calendar ID
event_idintegerYesThe event ID
integration_idintegerYesThe integration ID

Request Body

Integration-specific configuration (varies by integration type).

Response

Returns the updated integration object.

Delete Integration

Remove an integration from an event.

Endpoint

http
DELETE /calendars/{id}/events/{event_id}/integrations/{integration_id}

URL Parameters

ParameterTypeRequiredDescription
idintegerYesThe calendar ID
event_idintegerYesThe event ID
integration_idintegerYesThe integration ID

Response

json
{
    "message": "Successfully deleted the Integration."
}

Clone Event Integrations

Copy integrations from another event.

Endpoint

http
POST /calendars/{id}/events/{event_id}/integrations/clone

URL Parameters

ParameterTypeRequiredDescription
idintegerYesThe calendar ID
event_idintegerYesThe target event ID

Request Body

ParameterTypeRequiredDescription
from_event_idintegerYesThe event ID to copy integrations from

Response

json
{
    "message": "Integrations have been successfully cloned."
}

Get Integration Merge Fields

Get available merge fields for an integration.

Endpoint

http
GET /calendars/{id}/events/{event_id}/integrations/{integration_id}/merge-fields

URL Parameters

ParameterTypeRequiredDescription
idintegerYesThe calendar ID
event_idintegerYesThe event ID
integration_idintegerYesThe integration ID

Query Parameters

ParameterTypeRequiredDescription
integration_namestringYesThe integration identifier (e.g., fluentcrm, mailchimp)
list_idstringNoThe list/audience ID to get merge fields for

Response

json
{
    "merge_fields": {
        "...": "Integration-specific merge field definitions"
    }
}

Get Integration Config Options

Get configuration field options for an integration.

Endpoint

http
GET /calendars/{id}/events/{event_id}/integrations/{integration_id}/config-field-options

URL Parameters

ParameterTypeRequiredDescription
idintegerYesThe calendar ID
event_idintegerYesThe event ID
integration_idintegerYesThe integration ID

Query Parameters

ParameterTypeRequiredDescription
integration_namestringYesThe integration identifier
settingsobjectNoCurrent integration settings for context

Response

json
{
    "field_options": {
        "...": "Integration-specific configuration options"
    }
}