View as Markdown
Codat icon

Codat TRIGGER

New Webhook Message (Instant)

Emit new event when a specified event type is produced by Codat. See the documentation
  • Trigger
  • Instant
  • API key
  • Webhook delivery

IMPLEMENTATION

Deploy this event source

Connect the user's Codat account, configure the source, and choose the webhook where your backend receives events.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const deployed = await pd.triggers.deploy({
  id: "codat-new-webhook-message-instant",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    codat: { authProvisionId: "apn_xxxxxxx" },
    eventTypes: ["Event Type"],
    companyId: "Company ID",
  },
  webhookUrl: "https://example.com/webhooks/codat",
})

console.log(deployed.id)

MCP exposes on-demand actions. Event sources are deployed through the Connect SDK or API because they continue listening after the initial request.

SCHEMA

Configuration

These inputs define which events the source watches. Dynamic options are loaded from the connected account.

New Webhook Message (Instant) configuration
Property Type Description
eventTypes Event Type string[]
The type of event to emit when it is produced by Codat
Required
companyId Company ID string
Unique identifier of the company to indicate company-specific events. The associated webhook consumer will receive events only for the specified ID.
Required Dynamic

01

Connect

Your user authorizes Codat through Pipedream managed auth.

02

Deploy

Your backend deploys this source with that user's own configuration.

03

Webhook delivery

Every event is sent to the HTTP endpoint you choose when you deploy the source — as it happens.

OR

On-demand retrieval

No webhook required. Your app or agent can fetch recent events from the trigger events API.

Registry key
codat-new-webhook-message-instant
Version
0.0.1
App
Codat
Authentication
API key
Delivery
Instant event
Output
Events emitted by Codat.