Codat TRIGGER
New Webhook Message (Instant)
- 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)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/triggers/deploy \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "codat-new-webhook-message-instant",
"webhook_url": "https://example.com/webhooks/codat",
"configured_props": {
"codat": { "authProvisionId": "apn_xxxxxxx" },
"eventTypes": ["Event Type"],
"companyId": "Company ID"
}
}'MCP servers expose Codat actions as on-demand tools.
New Webhook Message (Instant) is an event source, so your application deploys it
with the Connect SDK or API and then either receives each event at a
webhook URL or retrieves events on demand with the trigger events API.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.
| 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 |
LIFECYCLE
Event delivery
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.
REFERENCE
Trigger details
- Registry key
- codat-new-webhook-message-instant
- Version
- 0.0.1
- App
- Codat
- Authentication
- API key
- Delivery
- Instant event
- Output
- Events emitted by Codat.
- Source
- View on GitHub ↗