Webhooks

CodeWords Webhooks are HTTP endpoints that allow external systems to send data directly to your CodeWords workflows or Agents.

Get Started with Webhooks

You can use Cody to create and manage webhooks that let CodeWords connect with other apps and services. A webhook works like a trigger — whenever something happens in another app (like a form is submitted, a file is uploaded, or data changes), it can automatically start a CodeWords workflow.

Webhooks are useful when you want your workflow to react to new data instantly — for example, when a CRM update or external API call should launch an automation. They can also send data back once the workflow is finished, making them great for building API-style automations that process data and return results in real time.

Authentication

No CodeWords API key required is required as the webhook URL itself serves as authentication. Each webhook has a unique, hard-to-guess URL that acts as a secure access point so make sure to keep this URL private — anyone with the link can send data to your workflow.

Technical Details

• Always deployed with app="codewords" and trigger="webhook" .

• Generates a unique CodeWords webhook URL.

• External systems POST JSON data directly to that URL.

• Designed to receive data from external systems and send event notifications as POST requests with a JSON payload.

HTTP Method

CodeWords currently supports only POST HTTP Request Methods

Example of anCodeWords Webhook URL

https://runtime.codewords.ai/webhook/pipedream/webhook/cmcdms29y00003o1ydhuu8jw5/gmail_to_salesforce_automation_webhook

Path

This contains a randomly generated webhook URL path, to avoid conflicts with other webhook urls on the CodeWords ecosystem.

CodeWordsWebhook structure breakdown

https://runtime.codewords.ai/webhook/pipedream/webhook/{unique_id}/{endpoint_name}

• Protocol: https://

• Base Domain: runtime.codewords.ai

• Path: /webhook/pipedream/webhook/

• Unique ID: cmcdms29y00003o1ydhuu8jw5 (randomly generated, hard to guess)

• Endpoint: /Service_webhook

Webhook Setup

1

Creates a test webhook

Cody generates a temporary webhook URL to understand the kind of data your external app or service will send.

2

Connect your external system

Add this test webhook URL in your app (like GitHub, Stripe, or any other service**) and trigger a test event.

3

Analyzes the incoming data

Cody automatically inspects the payload sent by your system and learns its structure.

4

Build the webhook service

It then creates a new service with two endpoints that follow the webhook pattern — one for testing and one for production.

5

Deploy the production webhook

Cody launches the live webhook endpoint for real usage.

6

Update your external system

Replace the test URL with the production webhook URL in your external app to complete the setup.