Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Webhooks::Outgoing::Endpoint

Create Endpoint

Add a new webhook endpoint to a workspace

post/workspaces/{workspace_id}/webhooks/outgoing/endpoints

Path parameters

workspace_idinteger required

Request body

Example request

{
  "webhooks_outgoing_endpoint": {
    "webhooks_outgoing_endpoint": {
      "url": "https://example.com/some-endpoint-url",
      "name": "Example Endpoint",
      "event_type_ids": [
        "contact.identified",
        "one-time-order.completed"
      ],
      "page_ids": [],
      "funnel_ids": []
    }
  }
}

Response

Created

idinteger

Unique identifier for the webhook endpoint

public_idstring nullable

Unique identifier for the webhook endpoint visible in the UI

workspace_idinteger

Workspace ID

urlstring

The URL that ClickFunnels event webhooks will be sent to.

namestring

The custom name for the webhook endpoint.

{"stackTrail":"components:schemas:WebhooksOutgoingEndpointAttributes:properties:event_type_ids","oasType":"schema","type":"unknown","description":"The event types that the webhook endpoint subscribes to. Each entry is a dotted or slashed string key\n(e.g. `contact.updated`, `order.completed`, `orders/invoice.paid`) — these are NOT numeric IDs.\nRetrieve the full list of valid keys from GET /api/v2/webhooks/outgoing/event_types\n(operationId: `listWebhooksOutgoingEventTypes`). The <a class='link' target='_blank'\nhref='https://developers.myclickfunnels.com/docs/webhook-event-types'>Webhook Event Types guide</a>\nprovides supplementary context.\n"}
api_versioninteger nullable

The version of the API that the webhook endpoint is using. Only V2 endpoints can currently be created via the API, but V1 endpoints can be created via the UI. They will be visible when listing endpoints.

created_atstring date-time nullable

Created at

updated_atstring date-time nullable

Updated at

Example response

{
  "id": 1,
  "public_id": "RcHPAt",
  "workspace_id": 42000,
  "url": "https://example.com/some-endpoint-url",
  "name": "Example Endpoint",
  "event_type_ids": [
    "contact.identified",
    "one-time-order.completed"
  ],
  "api_version": 2,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "page_ids": [],
  "funnel_ids": []
}