NeetoDesk Zapier integration

Connect NeetoDesk to other apps with Zapier

Zapier lets you connect NeetoDesk to thousands of other applications. Automated connections, called Zaps, can be set up in minutes with no coding and 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.

You need to create a Zap to connect NeetoDesk with any other app on Zapier. Here is a demo video on how to make a Zap using NeetoDesk.

Need inspiration? See everything that's possible with neetoDesk 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 NeetoDesk Zapier app requires an API key for authenticating any request it makes to NeetoDesk. Follow these steps to generate an API Key:

  1. Go to the Settings page in NeetoDesk.

  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 the green box. This API Key will not be made visible again. So make sure to save this somewhere secure if the API key is needed again.

API Documentation

Authentication

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

Headers:

Authorization: Basic <API Key>

Output:

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

Zapier Events

A Webhook or REST hook enables neetoDesk to send data on new tickets, updated tickets, closed tickets, new customers, or new comments to Zapier in real time. It can also be used on other platforms.

Subscribe

To start receiving data on a new tickets, updated tickets, closed tickets, new customers, or new comments, a request to subscribe should be sent to the following endpoint:

POST /neeto_integrations/zapier/subscriptions

Headers:

Authorization: Basic <API Key>

Body for new ticket:

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

Body for updated ticket:

{
    "zapier_subscription": { 
        "options" : {
          "url": /* URL to which updated tickets are to be sent */,
          "event": "updated_ticket"
        },
        "subscription_for": "Zapier"
    }
}

Body for the closed ticket:

{
    "zapier_subscription": { 
        "options" : {
          "url": /* URL to which closed tickets are to be sent */,
          "event": "closed_ticket"
        },
        "subscription_for": "Zapier"
    }
}

Body for a new customer:

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

Body for a new comment:

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

Sample Output:

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

Once subscribed, neetoDesk will send data on any new ticket, updated ticket, new customer, or new comment 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 for new ticket:

{
  "id": "f15bd712-b7ad-4445-8f51-aa414c6f4d31",
  "created_at": "2023-07-06T08:23:33.843Z",
  "subject": "Please create a ticket for me, Please!",
  "channel": "ui",
  "category": "Incident",
  "number": 1,
  "priority": "high",
  "status": "new",
  "consumer": {
    "id": "ac10cd09-5f3a-4711-8224-b6105191c9e9",
    "description": "",
    "email": "[email protected]",
    "language": "English",
    "time_zone": "Eastern Time (US & Canada)",
    "source": "dashboard"
  },
  "description_comment": {
    "author_type": "Consumer",
    "comment_type": "description",
    "info": {
      "body": "This is the content"
    }
  },
  "agent": {
    "id": "3b33f35a-24f2-4a60-b965-4ff4c58e5aee",
    "first_name": "Young",
    "last_name": "Hansen",
    "email": "[email protected]"
  },
  "group": {
    "id": "71f5c3ca-18af-4cfa-b8fe-892be28b8a0e",
    "name": "Salley Turner",
    "description": "Dolore omnis ut. Et soluta sequi. Ea harum sit."
  }
}

Sample data for updated ticket:

{
  "id": "d637769f-46d6-4c6e-93a9-e663bf2cca91",
  "created_at": "2023-07-06T08:28:37.510Z",
  "updated_at": "2023-07-06T08:28:37.718Z",
  "subject": "Unable to generate invoice!",
  "channel": "ui",
  "category": "None",
  "number": 1,
  "priority": "high",
  "status": "open",
  "consumer": {
    "id": "b54eabff-d28e-4c67-ba4e-cde0d1e3b179",
    "description": "",
    "email": "[email protected]",
    "language": "English",
    "time_zone": "Eastern Time (US & Canada)",
    "source": "email"
  },
  "description_comment": {
    "author_type": "Consumer",
    "comment_type": "description",
    "info": {
      "body": "Another Comment"
    }
  },
  "group": {
    "id": "31ecefdf-ae5c-4bb7-ba73-39bb18b634b6",
    "name": "Otto Lind IV",
    "description": "Rerum eum iure. Sunt facere dolorum. Et dolorum voluptatem."
  }
}

Sample data for closed ticket:

{
  "id": "d637769f-46d6-4c6e-93a9-e663bf2cca91",
  "created_at": "2023-07-06T08:28:37.510Z",
  "updated_at": "2023-07-06T08:28:37.718Z",
  "subject": "Unable to generate invoice!",
  "channel": "ui",
  "category": "None",
  "number": 1,
  "priority": "high",
  "status": "open",
  "consumer": {
    "id": "b54eabff-d28e-4c67-ba4e-cde0d1e3b179",
    "description": "",
    "email": "[email protected]",
    "language": "English",
    "time_zone": "Eastern Time (US & Canada)",
    "source": "email"
  },
  "description_comment": {
    "author_type": "Consumer",
    "comment_type": "description",
    "info": {
      "body": "Another Comment"
    }
  },
  "group": {
    "id": "31ecefdf-ae5c-4bb7-ba73-39bb18b634b6",
    "name": "Otto Lind IV",
    "description": "Rerum eum iure. Sunt facere dolorum. Et dolorum voluptatem."
  }
}

Sample data for new customers:

{
  "id": "b3e988ee-6d4d-4f6f-b2b7-7534a3919952",
  "first_name": "jonnyboy",
  "last_name": null,
  "description": "",
  "email": "[email protected]",
  "language": "English",
  "time_zone": "Eastern Time (US \\u0026 Canada)",
  "metadata": {},
  "blocked_at": null,
  "created_at": "2023-07-06T07:22:03.662Z",
  "name": "jonnyboy"
}

Sample data for the new comment:

{
  "id": "75e998af-0d3e-475f-bb7a-06cbd8569e4a",
  "created_at": "2023-07-06T07:52:01.590Z",
  "author_type": "User",
  "comment_type": "reply",
  "channel_mode": null,
  "author": {
    "id": "b09fb643-16b8-4306-9ac9-4dab636d5be8",
    "email": "[email protected]",
    "name": "Jerrica Murphy"
  },
  "rich_text_info": {
    "id": "d90edd0e-581b-44bf-bbea-790391b2a5d4",
    "name": "info",
    "body": "Could you specific the invoice number that has issue?",
    "record_type": "Comment"
  }
}

Unsubscribe

To stop receiving data on new tickets, updated tickets, closed tickets, new customers, or new comments, 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 neetoDesk"
}

Ticket List

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

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

Query Parameters:

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

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

Headers:

Authorization: Basic <API Key>

Sample Output:

[
  {
   "id": "c3972798-5412-4c67-8c15-8ef1e1debb23",
   "subject": "Unable to generate invoice!",
   "number": 1,
   "priority": "low",
   "status": "open",
   "channel": "ui",
   "category": "Incident",
   "created_at": "2023-07-07T09:24:43.527Z",
   "resolved_at": null,
   "updated_at": "2023-07-07T09:24:43.527Z",
   "description": null,
   "agent": {
     "id": "d03cbe0b-43cc-4c67-8ae6-7a13e1e98b9f",
     "name": "John Doe",
     "email": "[email protected]"
   },
   "consumer": {
     "id": "83140958-a3de-4467-9f21-342f86d51c0c",
     "name": "Arturo"
   },
   "group": {
     "id": "340fbaac-0035-4787-a3f0-d5c030531a34",
     "name": "Miyoko Thompson"
   }
  }
]

Customer List

Get a list of recent customers in the organization from NeetoDesk. This enables Zapier to get sample data from NeetoDesk while creating a Zap.

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

Query Parameters:

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

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

Headers:

Authorization: Basic <API Key>

Sample Output:

[
  {
   "id": "3ad4b679-6f2a-41ea-91cf-a6adb0dd5b97",
   "name": "Letha",
   "email": "[email protected]",
   "created_at": "2023-07-07T09:38:14.324Z",
   "language": "English",
   "time_zone": "Eastern Time (US & Canada)",
   "description": "",
   "metadata": {},
   "first_name": "Letha",
   "last_name": ""
  }
]

Comment List

Get a list of recent comments in the organization through tickets from NeetoDesk. This enables Zapier to get sample data from NeetoDesk while creating a Zap.

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

Query Parameters:

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

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

Headers:

Authorization: Basic <API Key>

Sample Output:

[
  {
   "id": "e7c609fa-ce7f-41a7-9867-4a1fcd6e8043",
   "created_at": "2023-07-07T09:42:24.724Z",
   "author_type": "User",
   "comment_type": "reply",
   "channel_mode": null,
   "author": {
     "id": "26d3aff5-1b85-4f48-ab15-1ffa6e6f2688",
     "name": "Matt Harris",
     "email": "[email protected]"
   }
 }
]