MYmyclickfunnels
Webhooks::Outgoing::Endpoint

Update Endpoint

Changed on

Update a webhook endpoint for a workspace

put/webhooks/outgoing/endpoints/{id}

Request

Path parameters

idstring 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

OK

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.

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

webhook_secret_last_fourstring nullable

Last four characters of the endpoint's signing secret. Enough to tell whether the secret you hold is still the current one. The full value is returned only in the create response, as webhook_secret.

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": [],
  "webhook_secret_last_four": "c3d4"
}

Changes

  • 511d88b30aeaRevision changes
    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status