Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions services/external-actor-gateway-service/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2381,6 +2381,85 @@ webhooks:
additionalProperties: false
description: Triggered when a page version is published. The webhook payload contains details about the published page version including page ID, version ID, and publishing timestamp.
required: true
formSubmitted:
post:
description: Triggered when a form is submitted. The webhook payload contains details about the submitted form including form ID, submission ID, and submission timestamp.
responses:
"200":
description: Webhook received successfully
summary: Form Submitted
tags:
- Webhooks
requestBody:
content:
application/json:
schema:
type: object
properties:
eventId:
description: Unique identifier for this event
examples:
- evt_01j5k9m7n8p9q2r3s4t5v6w7x8
type: string
tenantId:
description: Tenant identifier for the event
examples:
- tenant_01j5k9m7n8p9q2r3s4t5v6w7x8
type: string
timestamp:
description: Timestamp when the event was processed
examples:
- 2024-01-15T10:30:00Z
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
payload:
type: object
properties:
type:
description: Event type identifier
type: string
enum:
- form.submitted
formId:
description: Unique identifier for the form
examples:
- form_01j5k9m7n8p9q2r3s4t5v6w7x8
type: string
submissionId:
description: Unique identifier for the form submission
examples:
- formsubmission_01j5k9m7n8p9q2r3s4t5v6w7x8
type: string
submittedAt:
description: Timestamp when the form submission was submitted
examples:
- 2024-01-15T10:30:00Z
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
input:
description: Input data for the form submission
examples:
- name: email
value: [email protected]
type: object
additionalProperties: {}
required:
- type
- formId
- submissionId
- submittedAt
- input
additionalProperties: false
required:
- eventId
- tenantId
- timestamp
- payload
additionalProperties: false
description: Triggered when a form is submitted. The webhook payload contains details about the submitted form including form ID, submission ID, and submission timestamp.
required: true
tags:
- name: Page Groups
description: Page group management operations
Expand Down
Loading