A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://developers.intercom.com/docs/references/rest-api/api.intercom.io/custom-channel-events below:

Custom Channel Events

Intercom API (2.14)

The intercom API reference.

Download OpenAPI description

The production API server The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

AI Content

With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.

External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.

Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.

You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",

Articles

Everything about your Articles

Away Status Reasons

Everything about your Away Status Reasons

Companies

Everything about your Companies

Conversations

Everything about your Conversations

Custom Channel Events

With the "Custom Channel" integration, you can bring Fin and Intercom capabilities to your own platform via API, enabling powerful custom integrations.

Intercom treats your integration like any other Intercom channel, allowing your application and Intercom to exchange events seamlessly. This makes it possible, for example, for your users to interact with Fin directly within your own application’s UI.

Note: "Fin over API" is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

Notify Intercom of a new conversation created in a custom channel Request

Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration.

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

Bodyapplication/jsonrequired

Unique identifier for the event.

external_conversation_idstringrequired

Identifier for the conversation in your application.

contactobject(Custom Channel - Simplified Contact)required contact.​typestringrequired

Type of contact, must be "user" or "lead".

Enum"user""lead"

contact.​external_idstringrequired

External identifier for the contact. Intercom will take care of the mapping of your external_id with our internal ones so you don't have to worry about it.

Name of the contact. Required for user type.

contact.​emailstring(email)

Email address of the contact. Required for user type.

curl -i -X POST \
  https://api.intercom.io/custom_channel_events/notify_new_conversation \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "event_id": "evt_12345",
    "external_conversation_id": "conv_67890",
    "contact": {
      "type": "user",
      "external_id": "user_001",
      "name": "Jane Doe",
      "email": "jane.doe@example.com"
    }
  }'

Successfully notified Intercom

Bodyapplication/json external_conversation_idstringrequired

The external conversation ID provided in the notification request

conversation_idstringrequired

The Intercom conversation ID mapped to the external conversation ID

external_contact_idstringrequired

The external contact ID provided in the notification request

The Intercom contact ID mapped to the external contact ID

{ "external_conversation_id": "customer_conversation_id_12", "conversation_id": "intercom_conversation_id_34", "external_contact_id": "customer_contact_id_56", "contact_id": "intercom_contact_id_79" }

Notify Intercom of a new message in a custom channel conversation Request

Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations.

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

Bodyapplication/jsonrequired

Unique identifier for the event.

external_conversation_idstringrequired

Identifier for the conversation in your application.

contactobject(Custom Channel - Simplified Contact)required contact.​typestringrequired

Type of contact, must be "user" or "lead".

Enum"user""lead"

contact.​external_idstringrequired

External identifier for the contact. Intercom will take care of the mapping of your external_id with our internal ones so you don't have to worry about it.

Name of the contact. Required for user type.

contact.​emailstring(email)

Email address of the contact. Required for user type.

The message content sent by the user.

curl -i -X POST \
  https://api.intercom.io/custom_channel_events/notify_new_message \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "event_id": "evt_54321",
    "external_conversation_id": "conv_98765",
    "contact": {
      "type": "user",
      "external_id": "user_002",
      "name": "John Smith",
      "email": "john.smith@example.com"
    },
    "body": "Hello, I need help with my order."
  }'

Successfully notified Intercom

Bodyapplication/json external_conversation_idstringrequired

The external conversation ID provided in the notification request

conversation_idstringrequired

The Intercom conversation ID mapped to the external conversation ID

external_contact_idstringrequired

The external contact ID provided in the notification request

The Intercom contact ID mapped to the external contact ID

{ "external_conversation_id": "customer_conversation_id_12", "conversation_id": "intercom_conversation_id_34", "external_contact_id": "customer_contact_id_56", "contact_id": "intercom_contact_id_79" }

Notify Intercom of a quick reply response in a custom channel conversation Request

Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations.

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

Bodyapplication/jsonrequired

Unique identifier for the event.

external_conversation_idstringrequired

Identifier for the conversation in your application.

contactobject(Custom Channel - Simplified Contact)required contact.​typestringrequired

Type of contact, must be "user" or "lead".

Enum"user""lead"

contact.​external_idstringrequired

External identifier for the contact. Intercom will take care of the mapping of your external_id with our internal ones so you don't have to worry about it.

Name of the contact. Required for user type.

contact.​emailstring(email)

Email address of the contact. Required for user type.

quick_reply_option_idstringrequired

Id of the selected quick reply option.

curl -i -X POST \
  https://api.intercom.io/custom_channel_events/notify_quick_reply_selected \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "event_id": "evt_67890",
    "external_conversation_id": "conv_13579",
    "contact": {
      "type": "user",
      "external_id": "user_003",
      "name": "Alice Example",
      "email": "alice@example.com"
    },
    "quick_reply_option_id": "1234"
  }'

Successfully notified Intercom

Bodyapplication/json external_conversation_idstringrequired

The external conversation ID provided in the notification request

conversation_idstringrequired

The Intercom conversation ID mapped to the external conversation ID

external_contact_idstringrequired

The external contact ID provided in the notification request

The Intercom contact ID mapped to the external contact ID

{ "external_conversation_id": "customer_conversation_id_12", "conversation_id": "intercom_conversation_id_34", "external_contact_id": "customer_contact_id_56", "contact_id": "intercom_contact_id_79" }

Notify Intercom of an attribute collector response in a custom channel conversation Request

Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations.

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

Bodyapplication/jsonrequired

Unique identifier for the event.

external_conversation_idstringrequired

Identifier for the conversation in your application.

contactobject(Custom Channel - Simplified Contact)required contact.​typestringrequired

Type of contact, must be "user" or "lead".

Enum"user""lead"

contact.​external_idstringrequired

External identifier for the contact. Intercom will take care of the mapping of your external_id with our internal ones so you don't have to worry about it.

Name of the contact. Required for user type.

contact.​emailstring(email)

Email address of the contact. Required for user type.

attributeobject(Custom Channel - Attribute)required attribute.​idstringrequired

Identifier for the attribute being collected.

attribute.​valuestringrequired

Value provided by the user for the attribute.

curl -i -X POST \
  https://api.intercom.io/custom_channel_events/notify_attribute_collected \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "event_id": "evt_24680",
    "external_conversation_id": "conv_11223",
    "contact": {
      "type": "user",
      "external_id": "user_004",
      "name": "Bob Example",
      "email": "bob@example.com"
    },
    "attribute": {
      "id": "shipping_address",
      "value": "123 Main St, Springfield"
    }
  }'

Successfully notified Intercom

Bodyapplication/json external_conversation_idstringrequired

The external conversation ID provided in the notification request

conversation_idstringrequired

The Intercom conversation ID mapped to the external conversation ID

external_contact_idstringrequired

The external contact ID provided in the notification request

The Intercom contact ID mapped to the external contact ID

{ "external_conversation_id": "customer_conversation_id_12", "conversation_id": "intercom_conversation_id_34", "external_contact_id": "customer_contact_id_56", "contact_id": "intercom_contact_id_79" }

Custom Object Instances

Everything about your Custom Object instances.

Permission Requirements

From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.

Data Attributes

Everything about your Data Attributes

Data Events

Everything about your Data Events

Data Export

Everything about your Data Exports

Help Center

Everything about your Help Center

Internal Articles

Everything about your Internal Articles

Messages

Everything about your messages

News

Everything about your News

Notes

Everything about your Notes

Reporting Data Export

Everything about Reporting Data Export

Segments

Everything about your Segments

Subscription Types

Everything about subscription types

Teams

Everything about your Teams

Ticket States

Everything about your ticket states

Ticket Type Attributes

Everything about your ticket type attributes

Ticket Types

Everything about your ticket types

Tickets

Everything about your tickets

Visitors

Everything about your Visitors


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4