openapi: 3.2.0
info:
title: ClickFunnels Webhooks::Outgoing::Event API
termsOfService: https://www.clickfunnels.com/terms-of-service
contact:
name: ClickFunnels API Team
url: https://developers.myclickfunnels.com
x-logo:
url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png
description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps.
'
license:
name: MIT
url: https://opensource.org/licenses/MIT
version: 2.0.0
servers:
- url: https://{subdomain}.myclickfunnels.com/api/v2
description: ClickFunnels API
variables:
subdomain:
default: myworkspace
security:
- BearerAuth: []
tags:
- name: Webhooks::Outgoing::Event
description: Webhooks Outgoing Events
paths:
/workspaces/{workspace_id}/webhooks/outgoing/events:
get:
tags:
- Webhooks::Outgoing::Event
summary: List Events
description: List webhook events for a workspace
operationId: listWebhooksOutgoingEvents
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/sort_order'
- $ref: '#/components/parameters/sort_property'
responses:
'200':
description: OK
headers:
Pagination-Next:
$ref: '#/components/headers/PaginationNext'
Link:
$ref: '#/components/headers/Link'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WebhooksOutgoingEventAttributes'
example:
- id: 2
public_id: wBbfEk
workspace_id: 42000
uuid: 60df598e94fdd1d53f202bbc1e05fa38
event_type_id: contact.identified
subject_id: 356
subject_type: Contact
data:
id: 246579500
tags: []
uuid: 3783f37654f74bd2c088c2ffef1ce685
fb_url: 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: 70
public_id: RNqczn
name: Great Page
funnel:
id: 12
public_id: NYHMbx
name: Example Funnel
- id: 3
public_id: PjwvXK
workspace_id: 42000
uuid: da366f422fda0814504d5d99ea43c873
event_type_id: contact.identified
subject_id: 357
subject_type: Contact
data:
id: 246579500
tags: []
uuid: 3783f37654f74bd2c088c2ffef1ce685
fb_url: 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: 71
public_id: btqSVe
name: Great Page
funnel:
id: 13
public_id: RdPbtf
name: Example Funnel
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
example:
error: API key missing or invalid
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID.
example:
error: 'Not found: Record missing'
/webhooks/outgoing/events/{id}:
get:
tags:
- Webhooks::Outgoing::Event
summary: Fetch Event
description: Retrieve an webhook event for a workspace
operationId: getWebhooksOutgoingEvents
parameters:
- $ref: '#/components/parameters/id'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WebhooksOutgoingEventAttributes'
example:
id: 4
public_id: IsYPBy
workspace_id: 42000
uuid: db367bc0feec4c1a09c8d7cfa708143c
event_type_id: contact.identified
subject_id: 358
subject_type: Contact
data:
id: 246579500
tags: []
uuid: 3783f37654f74bd2c088c2ffef1ce685
fb_url: 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: 72
public_id: xTkhut
name: Great Page
funnel:
id: 14
public_id: WUKmDS
name: Example Funnel
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
example:
error: API key missing or invalid
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: string
example:
error: 'Not found: Record missing'
components:
parameters:
id:
name: id
in: path
required: true
schema:
type: string
sort_property:
name: sort_property
in: query
description: '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.
'
required: false
schema:
type: string
enum:
- id
- updated_at
sort_order:
name: sort_order
in: query
description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination).
required: false
schema:
type: string
enum:
- asc
- desc
after:
name: after
in: query
required: false
schema:
type: string
description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination).
headers:
Link:
description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value.
schema:
type: string
PaginationNext:
description: ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page.
schema:
type: string
schemas:
WebhooksOutgoingEventAttributes:
type: object
title: Webhooks Events
description: Webhooks Events
properties:
id:
type: integer
description: Unique identifier for the webhook event
public_id:
type:
- string
- 'null'
description: Unique identifier for the webhook event visible in the UI
workspace_id:
type: integer
description: Workspace ID
uuid:
type:
- string
- 'null'
description: Unique UUID identifier for the webhook event
event_type_id:
type:
- string
- 'null'
description: The ID of the event type. Can be any ID from the list of event types.
subject_id:
type: integer
description: 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_type:
type:
- string
- 'null'
description: The type of the subject of the event. E.g., for the `contact.identified` event_type_id, the `subject_type` is `Contact`.
data:
type: object
description: '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_version:
type:
- integer
- 'null'
description: 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_at:
type:
- string
- 'null'
format: date-time
description: Created at
page:
type:
- object
- 'null'
title: Page
description: Page
properties:
id:
type: integer
description: Page ID
public_id:
type:
- string
- 'null'
description: The public identifier of the page
name:
type: string
description: Page name of the editable page element. Want to filter by it? See our help guide on that topic.
funnel:
type:
- object
- 'null'
title: Funnel
description: Funnel
properties:
id:
type: integer
description: Funnel ID
public_id:
type:
- string
- 'null'
description: The public identifier of the funnel
name:
type: string
description: Name of the Funnel
example:
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
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
required:
- api_version
- created_at
- data
- event_type_id
- funnel
- id
- page
- public_id
- subject_id
- subject_type
- uuid
- workspace_id
securitySchemes:
BearerAuth:
type: http
scheme: bearer
externalDocs:
description: More in-depth guides and further resources
url: https://developers.myclickfunnels.com