New Webhook Message (Instant) from Codat API

Pipedream makes it easy to connect APIs for Codat and 2,400+ other apps remarkably fast.

Trigger workflow on

New Webhook Message (Instant) from the Codat API

Next, do this

Connect to 2,400+ APIs using code and no-code building blocks

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Trigger a workflow on New Webhook Message (Instant) with Codat API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the New Webhook Message (Instant) trigger
1. Connect your Codat account
2. Select one or more Event Type
3. Select a Company ID
Add steps to connect to 2,400+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Get Film with SWAPI - Star Wars API on New Webhook Message (Instant) from Codat API

Codat + SWAPI - Star Wars

Try it

Send any HTTP Request with HTTP / Webhook API on New Webhook Message (Instant) from Codat API

Codat + HTTP / Webhook

Try it

Get Backlinks with Ahrefs API on New Webhook Message (Instant) from Codat API

Codat + Ahrefs

Try it

Execute Query with Snowflake API on New Webhook Message (Instant) from Codat API

Codat + Snowflake

Try it

[Date/Time] Add/Subtract Time with Formatting API on New Webhook Message (Instant) from Codat API

Codat + Formatting

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

New Webhook Message (Instant) on Codat

Description:Emit new event when a specified event type is produced by Codat. [See the documentation](https://docs.codat.io/platform-api#/operations/create-webhook-consumer)

Version:0.0.1

Key:codat-new-webhook-message-instant

View on GitHub

Code#

import codat from "../../codat.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "codat-new-webhook-message-instant",
  name: "New Webhook Message (Instant)",
  description: "Emit new event when a specified event type is produced by Codat. [See the documentation](https://docs.codat.io/platform-api#/operations/create-webhook-consumer)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    codat,
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    eventTypes: {
      propDefinition: [
        codat,
        "eventTypes",
      ],
    },
    companyId: {
      propDefinition: [
        codat,
        "companyId",
      ],
    },
  },
  hooks: {
    async activate() {
      const data = {
        url: this.http.endpoint,
        eventTypes: this.eventTypes,
      };
      if (this.companyId) {
        data.companyId = this.companyId;
      }
      const { id } = await this.codat.createWebhook({
        data,
      });
      this._setHookId(id);
    },
    async deactivate() {
      const hookId = this._getHookId();
      if (hookId) {
        await this.codat.deleteWebhook({
          hookId,
        });
      }
    },
  },
  methods: {
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    generateMeta(body) {
      return {
        id: body.AlertId,
        summary: body.Message,
        ts: Date.now(),
      };
    },
  },
  async run({ body }) {
    this.http.respond({
      status: 200,
    });
    const meta = this.generateMeta(body);
    this.$emit(body, meta);
  },
  sampleEmit,
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Codat	`codat`	`app`	This component uses the Codat app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Event Type	`eventTypes`	`string[]`	Select a value from the drop down menu:`{ "value": "AccountCategoriesUpdated", "label": "Triggered anytime a company's accounts are categorized. This can be when Codat updates the suggested category fields or a user updates the confirmed category fields." }{ "value": "bankFeeds.sourceAccount.connected", "label": "Indicates a bank feed source account has changed to a status of connected." }{ "value": "bankFeeds.sourceAccount.disconnected", "label": "Indicates a bank feed source account has changed to a status of disconnected." }{ "value": "ClientRateLimitReached", "label": "Triggered when the number of requests to Codat's API from the client exceeds the current quota." }{ "value": "ClientRateLimitReset", "label": "Triggered when the rate limit quota has reset for the client, and more requests to the API are available." }{ "value": "DataConnectionStatusChanged", "label": "Triggered when a data connection status of a specific company changes." }{ "value": "DataSyncCompleted", "label": " Generated for each dataType to indicate that data synchronization is successfully completed for that specific data type." }{ "value": "DataSyncStatusChangedToError", "label": "Triggered when the synchronization of a dataset fails." }{ "value": "DatasetDataChanged", "label": " Generated for each dataType to indicate that dataset synchronization has completed and updated Codat's data cache through the creation of new records or a change to existing records." }{ "value": "NewCompanySynchronized", "label": "Triggered when initial syncs are complete for all data types queued for a newly connected company, and at least one of those syncs is successful." }{ "value": "PushOperationStatusChanged", "label": "Indicates that a create, update, or delete operation's status has changed. You can learn more about push operations at Codat." }{ "value": "PushOperationTimedOut", "label": "Indicates that a create, update, or delete operation has timed out. You can learn more about timeouts for push operations at Codat." }{ "value": "SyncCompleted", "label": "Triggered anytime an expense sync completes. Used for Sync for Expenses only." }{ "value": "SyncConnectionDeleted", "label": "Indicates a Sync for Commerce connection has been deleted. Used for Sync for Commerce only." }{ "value": "SyncFailed", "label": "Indicates a failure occurred during an expense sync. Used for Sync for Expenses only." }`
Company ID	`companyId`	`string`	Select a value from the drop down menu.

Authentication#

Codat uses API keys for authentication. When you connect your Codat account, Pipedream securely stores the keys so you can easily authenticate to Codat APIs in both code and no-code steps.

To retrieve your API keys and Authorization Header,