MYmyclickfunnels
Webhooks::Outgoing::Event

List Events

Changed on

List webhook events for a workspace

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

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 event

public_idstring nullable

Unique identifier for the webhook event visible in the UI

workspace_idinteger

Workspace ID

uuidstring nullable

Unique UUID identifier for the webhook event

event_type_idstring nullable

The ID of the event type. Can be any ID from <a class='link' target='_blank' href='https://developers.myclickfunnels.com/docs/webhook-event-types'>the list of event types</a>.

subject_idinteger

The ID of the subject of the event. E.g., for the one-time-order.completed event_type_id, the subject_id is the ID of an Order.

subject_typestring nullable

The type of the subject of the event. E.g., for the contact.identified event_type_id, the subject_type is Contact.

dataobject

The webhook data payload with the data of the event. This data corresponds to the subject's response schema. E.g., for the contact.identified event_type_id, the subject_type is Contact. So, you can expect the data structure to be as described in the response schema of the Contact endpoints.

api_versioninteger nullable

API version of the webhook event. Only V2 webhook events will be triggered from endpoints created via the API, but in the list of events you will encounter V1 events if UI users set up V1 endpoints via the UI.

created_atstring date-time nullable

Created at

Example response

[
  {
    "id": 1,
    "public_id": "oMrXDs",
    "workspace_id": 42000,
    "uuid": "18b1d340cfd584cb0348485cd178a89d",
    "event_type_id": "contact.identified",
    "subject_id": 40,
    "subject_type": "Contact",
    "data": {
      "id": 246579500,
      "tags": [],
      "uuid": "3783f37654f74bd2c088c2ffef1ce685",
      "fb_url": null,
      "default_shipping_address_id": null,
      "anonymous": 0,
      "last_name": null,
      "public_id": "YYEXRWP",
      "time_zone": null,
      "created_at": "2024-04-24T09:23:56.649Z",
      "first_name": "Bobby",
      "updated_at": "2024-04-24T09:23:56.871Z",
      "twitter_url": null,
      "website_url": null,
      "linkedin_url": null,
      "phone_number": null,
      "workspace_id": 152039,
      "email_address": "bobby@fuzzy.com",
      "instagram_url": null,
      "unsubscribed_at": null,
      "custom_attributes": {
        "preference": "always yes"
      },
      "last_notification_email_sent_at": null
    },
    "api_version": 2,
    "created_at": "2025-01-01T00:00:00.000Z",
    "page": {
      "id": 10,
      "public_id": "pPGNOY",
      "name": "Great Page"
    },
    "funnel": {
      "id": 2,
      "public_id": "yqkMTa",
      "name": "Example Funnel"
    }
  }
]

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