MYmyclickfunnels
Webhooks::Outgoing::Endpoint

List Endpoints

Changed on

List webhook endpoints for a workspace

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

Request

Path parameters

workspace_idstring required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

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
    • info

      added the new optional query request parameter per_page

    • info

      for the path request parameter workspace_id, the type was generalized from integer to string

    • info

      added the non-success 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