neetoChat Zapier integration

Connect neetoChat to other apps with Zapier

Zapier lets you connect neetoChat to thousands of other applications. Automated connections called Zaps can be set up in minutes with no coding that can automate your day-to-day tasks and build workflows between applications.

Each Zap has one app as the Trigger, where your information comes from and which causes one or more Actions in other apps, where your data gets sent automatically.

Getting Started with Zapier

Sign up for a free Zapier account, and from there you can jump right in.

To connect neetoChat with any other app on Zapier, you need to create a Zap. Here is a demo video on how to make a Zap using neetoChat.

Need inspiration? See everything that's possible with neetoChat and Zapier.

If you have any additional questions on how to use Zapier, you can open a ticket with Zapier Support from https://zapier.com/app/get-help.


API Key

The neetoChat Zapier app requires an API Key for authenticating any request it makes to neetoChat. Follow these steps to generate an API Key:

  1. Go to the Settings page in neetoChat.

  2. In the Integrations section click on Zapier.

  3. Enter a label for the new Zapier API Key and click on Generate API Key.

  4. Copy the API Key that is shown in a green box. This API Key will not be made visible again. So make sure to save this somewhere secure in case the API Key will be needed again.

API Documentation

Authentication Test

Zapier will use this endpoint to see if the API Key provided to it can be used to authenticate its requests successfully.

GET /api/v1/integrations/zapier/authentication_test

Headers:

Authorization: Basic <API Key>

Output:

{
    "notice": "Successfully authenticated API Key"
}

Zapier Events

A Webhook or REST hook enables neetoChat to send data on new conversations to Zapier, in real-time. It can also be used on other platforms.

Subscribe

To start receiving data on new conversations, a request to subscribe should be sent to the following endpoint:

POST /neeto_integrations/zapier/subscriptions

Headers:

Authorization: Basic <API Key>

Body:

{
    "zapier_subscription": { 
        "options" : {
          "url": /* URL to which new conversations are to be sent */,
          "event": "new_conversation"
        },
        "subscription_for": "Zapier"
    }
}

Sample Output:

{
    "notice": "Successfully subscribed to neetoChat",
    "id": "25934bd9-8742-4eb1-841e-6a78de0c4542"
}

Once subscribed, neetoChat will send data on any new conversation that is created through a POST request. The POST request will be sent to the value of zapier_subscription.options.url, provided in the request body of the Subscribe request.

Sample Data:

{
  "id": "588135e7-856e-44bb-8dcf-b9cf2758e714",
  "status": "open",
  "closed_at": "2022-11-23T13:16:55.717Z",
  "origin_page_url": "http://subdomain.neetochat.com/",
  "origin_page_title": "neetoChat Widget Tester",
  "created_at": "2022-11-22T13:16:55.717Z",
  "type": "Widget::Conversation",
  "moved_to_closed": false,
  "title": "Query on using the widget"
}

Unsubscribe

To stop receiving data on new conversations, a request to unsubscribe should be sent to the following endpoint:

DELETE /neeto_integrations/zapier/subscriptions/<API Key>

Headers:

Authorization: Basic <API Key>

Sample Output:

{
    "notice": "Successfully unsubscribed to neetoChat"
}

Conversation List

Get a list of recent conversations in the organization from neetoChat. This enables Zapier to get sample data from neetoChat, during the creation of a Zap.

GET /api/v1/integrations/zapier/conversations?page_size=3&page=1

Query Parameters:

  • page_size - This is the number of conversations to be returned per page. The default value is 3.

  • page - This is the page number to be returned. The default value is 1.

Headers:

Authorization: Basic <API Key>

Sample Output:

[
  {
    "id": "588135e7-856e-44bb-8dcf-b9cf2758e714",
    "status": "open",
    "closed_at": "2022-11-23T13:16:55.717Z",
    "origin_page_url": "http://subdomain.neetochat.com/",
    "origin_page_title": "neetoChat Widget Tester",
    "created_at": "2022-11-22T13:16:55.717Z",
    "type": "Widget::Conversation",
    "moved_to_closed": false,
    "title": "Query on using the widget"
  }
]