GET CUSTOMER INTEGRATIONS

Query integrations associated with the given customer API key

QUERY ALL

GET https://api.eyelevel.ai/v1/partner/integration/:apiKey

Path Parameters

Query Parameters

{
    "integrations": [
        {
            "audienceId":       "STRING IDENTIFIER",
            "channelName":      "STRING",
            "channelId":        "STRING IDENTIFIER",
            "clientId":         "STRING IDENTIFIER",
            "eventName":        "STRING",
            "groupTextNumbers": "STRING",
            "name":             "STRING",
            "isVerified":       BOOLEAN,
            "platform":         "ENUMERATED STRING",
            "phoneNumbers":     "STRING",
            "teamId":           "STRING",
            "type":             "ENUMERATED STRING",
            "updated":          DATETIME,
            "workspaceId":      "STRING"
        }
    ]
}

Response

{
    "integrations": [
        {
            "audienceId":       "STRING IDENTIFIER",
            "channelName":      "STRING",
            "channelId":        "STRING IDENTIFIER",
            "clientId":         "STRING IDENTIFIER",
            "eventName":        "STRING",
            "groupTextNumbers": "STRING",
            "name":             "STRING",
            "isVerified":       BOOLEAN,
            "platform":         "ENUMERATED STRING",
            "phoneNumbers":     "STRING",
            "teamId":           "STRING",
            "type":             "ENUMERATED STRING",
            "updated":          DATETIME,
            "workspaceId":      "STRING"
        }
    ]
}

audienceId

The unique identifier for the Mailchimp audience associated with the Mailchimp integration.

channelName

The human readable name for the Slack or Microsoft Teams channel where EyeLevel alerts are posted.

channelId

The unique identifier for the Slack channel where EyeLevel alerts are posted.

clientId

The unique client identifier associated with the Marketo integration.

eventName

The Zapier event name used in triggers associated with the Zapier integration.

groupTextNumbers

A comma delimited list of phone numbers, including an EyeLevel phone number, that receive EyeLevel alerts associated with this integration.

name

The human readable name for the integration.

isVerified

A boolean value for whether the phone numbers associated with the SMS integration have been verified.

platform

The name of the third party integration. The value will be one of:

  • hubspot

  • mailchimp

  • marketo

  • msteams - for Microsoft Teams

  • mms - for SMS group texts

  • salesforce

  • slack

  • zapier

phoneNumbers

A comma delimited list of phone numbers, excluding an EyeLevel phone number, that receive EyeLevel alerts associated with this integration.

teamId

The unique identifier for the Microsoft Teams channel where EyeLevel alerts are posted.

type

The type of integration. The value will be one of:

  • channel - for marketing channel integrations

  • submit - for event tracking integrations

  • transfer - for live chat transfer integrations

updated

The datetime the integration was last updated in RFC3339 format.

workspaceId

The unique identifier for the Slack workspace where EyeLevel alerts are posted.

Last updated