Zapier Integration

Zapier lets you connect NeetoKB to thousands of other applications. Automated connections called Zaps can be set up in minutes with no coding to 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 NeetoKb with any other app on Zapier. Here is a demo video on how to make a Zap using NeetoKb.

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

If you have any additional questions about Zapier, you can open a ticket with Zapier Support at https://zapier.com/app/get-help.

API Key:

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

1. Go to the Settings page in NeetoKb.

2. In the Integrations section, click on Connect 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 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/admin/integrations/zapier/authentication

Headers:

Authorization: Basic <API Key>

Output:

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

Zapier Events

A Webhook or REST hook enables NeetoKb to send data on newly published articles to Zapier, in real-time. It can also be used on other platforms.

Subscribe:

To start receiving data on newly published articles, 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 published articles are to be sent */,
          "event": "article_published"
        },
        "subscription_for": "Zapier"
    }
}

Sample Output:

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

Once subscribed, NeetoKb will send data on any newly published article 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": "87b0eea3-17db-4c57-bcac-573d8229abf1",
  "title": "billing",
  "status": "active",
  "keywords": ["payment"],
  "page_title": "Sample Page Title",
  "meta_description": "Sample Meta Description",
  "state": "published",
  "commentable": false,
  "created_at": "2023-07-12T19:33:53.805Z",
  "html_content": "billing steps",
  "author": {
    "email": "[email protected]",
    "first_name": "Joan",
    "last_name": "McGlynn"
  },
  "category": {
    "name": "Agnus Donnelly"
  }
}

Unsubscribe

To stop receiving data on newly published articles, 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 neetoKb"
}

Article List

Get a list of recent articles from NeetoKb. This enables Zapier to get sample data from NeetoKb during the creation of a Zap.

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

Query Parameters:

• page_size - This is the number of articles 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": "2703a2d3-4041-44ca-82e1-d8be7df1eb91",
   "status": "active",
   "state": "published",
   "title": "Fuga est eaque assumenda.",
   "page_title": "Example Page Title",
   "keywords": ["keyword_one"],
   "created_at": "2023-07-12T19:45:31.266Z",
   "html_content": "Deleniti ab libero. In tenetur voluptatem. Sit officia    cumque.",
   "meta_description": "Example Meta Description",
   "commentable": true,
   "author": {
     "first_name": "Leon",
     "last_name": "Ziemann",
     "email": "[email protected]"
   },
   "category": {
     "name": "Nathanael Rice"
   }
  }
]