Channels
Prev  Customer Support  Next

Channels

The Channels modules allow you to create, update, retrieve, list, and delete the contacts in your Channels account.

Getting Started with Channels

Prerequisites

  • A Channels account

In order to use Channels with {{Make}}, it is necessary to have a Channels account. If you do not have one, you can create a Channels account at channels.app.

[Note] Note

The module dialog fields that are displayed in bold (in the {{Make}} scenario, not in this documentation article) are mandatory!
Connect Channels to {{Make}}

To connect your Channels account to {{Make}} you need to obtain the API Key from your Channels account and insert it in the Create a connection dialog in the {{Make}} module.

  1. Log in to your Channel account.

  2. Click Integrations > API Key > Generate.

    61f2689591e84.gif

  3. Copy the Channel name and API Key to a safe place.

    61f2689828413.png

  4. Go to {{Make}} and open the Channel module's Create a connection dialog.

    61f2689934dc2.gif

  5. In the Connection name field, enter a name for the connection.

  6. In the API Key and Account field, enter the API key and account details copied in step 3 and click Continue.

The connection has been established.

Contacts
List Contacts

Gets a list of all contacts.

Connection

Establish a connection to your Channel account.

Limit

Set the maximum number of contacts {{Make}} should return during one scenario execution cycle.
Get a Contact

Gets a specific contact by ID.

Connection

Establish a connection to your Channel account.
Create a Contact

Creates a new contact.

Connection

Establish a connection to your Channel account.

First Name

Enter the contact's first name.

Last Name

Enter the contact's last name.

Email Name

Enter the contact's email address.

Company Name

Enter the company name to which the contact belongs to.

External Link

Enter the external link for contact. For example, company website link.

Tag Names

Enter the tags for the contact. For example, new, prospect.

MSISDN

Enter the contact's phone number with the country code. For example, +15162593419.

Force New Entity

Select whether you want to enforce a new entity for the contact.

Existing Contact ID

Select the existing whose details to be overridden with this new contact.
Update a Contact

Updates contact.

Connection

Establish a connection to your Channel account.

Contact ID

Select the Contact ID whose details you want to update.

First Name

Enter the contact's first name.

Last Name

Enter the contact's last name.

Email Name

Enter the contact's email address.

Company Name

Enter the company name to which the contact belongs to.

External Link

Enter the external link for contact. For example, company website link.

Tag Names

Enter the tags for the contact. For example, new, prospect.

MSISDN

Enter the contact's phone number with the country code. For example, +15162593419.

Force New Entity

Select whether you want to enforce a new entity for the contact.

Existing Contact ID

Select the existing whose details to be overridden with this new contact.
Delete a Contact

Deletes a contact.

Connection

Establish a connection to your Channel account.

Contact ID

Select the Contact ID you want to delete.
Calls

See the Setting Up the Channel Webhooks to add webhooks in your Channel account.

Watch Incoming Call Status

Triggers to watch incoming call status.

Connection

Establish a connection to your Channel account.
Watch Answered Calls (Deprecated)

Triggers when a call is saved as successful.

Connection

Establish a connection to your Channel account.
Other
Make an API Call

Performs an arbitrary authorized API call.

Connection

Establish a connection to your Channel account.

URL

Enter a path relative to https://api.channels.app/api/. For example: /v1/contacts

[Note] Note

For the list of available endpoints, refer to the Channels API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.
Example of Use - Get All Contacts

The following API call returns all the contacts from your Channels account:

URL:

/v1/contacts

Method:

GET

61f2689b5fc5a.png

Matches of the search can be found in the module's Output under Bundle > Body > data.

In our example, 3 contacts were returned:

61f2689c717d3.png
Setting Up the Channel Webhooks

  1. Open any Watch module, enter a name for the webhook, click Save, and copy the URL address to your clipboard.

    61f2689d81777.gif

  2. Log in to your Channel account.

  3. Click Integrations > Webhooks.

    61f2689fd1136.gif

  4. Select the events you want to watch, enter a name for the webhook, and enter the webhook URL address copied in step1. Click Save.

    61f268a273ee8.png

You have successfully added the webhooks.

61f268a384e6b.png

You can now execute the scenario in {{Make}} and will receive triggers for specified webhook events.

Prev  Up  Next
Canny  Home  Customerly