We use cookies to ensure that we give you the best experience on our website.

Zapier Integration

Zapier lets you connect FoundAItion Chatbot to 2,000+ other web services. Automated connections called Zaps, set up in minutes with no coding, can automate your day-to-day tasks and build workflows between apps that otherwise wouldn’t be possible.

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, from there you can jump right in. To help you hit the ground running, here are some popular pre-made Zaps.

How do I connect FoundAItion Chatbot to Zapier?

  1. Log in to your Zapier account or create a new account.
  2. Navigate to “My Apps” from the top menu bar.
  3. Now click on “Connect a new account…” and search for “foundaition-chatbot”
  4. Use your credentials/API key to connect your FoundAItion Chatbot account to Zapier.
  5. Once that’s done you can start creating an automation! Use a pre-made Zap or create your own with the Zap Editor. Creating a Zap requires no coding knowledge and you’ll be walked step-by-step through the setup.
  6. Need inspiration? See everything that’s possible with FoundAItion Chatbot and Zapier.
  7. If you have any additional questions, you can open a ticket with Zapier Support.

API Documentation

Overview

This API, currently at version 1.0.0, provides an interface for interacting with a chatbot service. It is built to be compatible with platform version 15.11.0. The primary function of this API is to trigger events when new conversations are initiated in the chatbot system.

Authentication

The API uses a custom authentication method. The authentication process involves providing an API key, which is a GUID. This key is necessary for accessing the API and is supplied by FoundAItion, Inc.

Authentication Fields

  • API key
    • Type: password
    • Required: true
    • Label: API key
    • Help Text: GUID, example: 2885BA7F-B99B-4F29-80D2-8A9A2FE0A7AE, provided by FoundAItion, Inc

Authentication Test

To test the authentication, a request is sent to the following URL: https://us-central1-chatbot-internal-412216.cloudfunctions.net/zapier?request_type=auth

Request Template

When making requests to the API, the following template is used to include necessary parameters and headers:

Headers

  • X-API-KEY: {{bundle.authData.api_key}}

Triggers

New Chat Trigger

This trigger activates when a new conversation is added to the chatbot system. The details of the trigger are as follows:

  • Key: new_chat
  • Noun: Chat
  • Display:
    • Label: New Chat
    • Description: Triggers when a new conversation is added.
    • Hidden: false

Operations

  1. Perform Hook:

    • Source: return [bundle.cleanedRequest];
    • Type: hook

  2. Perform List:

    • URL: https://us-central1-chatbot-internal-412216.cloudfunctions.net/zapier?request_type=list
    • Headers:
      • Accept: application/json

  3. Perform Subscribe:

    • URL: https://us-central1-chatbot-internal-412216.cloudfunctions.net/zapier?request_type=subscribe
    • Method: POST
    • Headers:
      • Content-Type: application/json
      • Accept: application/json
    • Body:
      • hookUrl: {{bundle.targetUrl}}

  4. Perform Unsubscribe:

    • URL: https://us-central1-chatbot-internal-412216.cloudfunctions.net/zapier?request_type=unsubscribe
    • Method: DELETE
    • Headers:
      • Content-Type: application/json
      • Accept: application/json
    • Body:
      • hookUrl: {{bundle.subscribeData.id}}

Sample Data

A sample of the data returned by this trigger includes:

  • id: 01909e0b1
  • event_type: conversation_start
  • timestamp: 2024-07-19T14:03:20Z
  • message: hello

Output Fields

The data fields provided by this trigger include:

  • Id: id
  • Event Type: event_type
  • Timestamp: timestamp (datetime)
  • Message: message

This comprehensive API provides a robust solution for integrating with the chatbot system, enabling real-time interaction and monitoring of new conversations