API docs

Swagger-compatible OpenAPI contract for the standalone EPP form builder. The API exposes forms, publishing, submissions, and EPP connector acknowledgements. Use this with each form's Integration Kit for copy-paste embed snippets, field IDs, mapped payloads, and connector proof.

OpenAPI JSON

Validate at the server

Required fields, inactive forms, duplicate attendee policy, capacity caps, and published state are enforced by the EPP API.

Use idempotency

Send X-Idempotency-Key for retries. The server reserves/finalizes the response so duplicate requests do not create duplicate submissions.

Consume connector packets

Calendar, backend, PDF, and approval work is queued as connector packets and can be acknowledged after the customer system processes it.

Base contract

Base URL: /api/epp. The document is Swagger-compatible OpenAPI 3.1.

POST /api/epp/forms/{formId}/submissions
Content-Type: application/json
X-Idempotency-Key: <unique-request-id>

{
  "values": {
    "attendee_email": "jane@example.com"
  }
}

POST /api/epp/connectors/{packetId}/ack
Content-Type: application/json

{
  "status": "acked",
  "note": "Processed by customer system"
}

get/api/epp/forms

Forms

List forms

post/api/epp/forms

Forms

Create a form from an EPP template

get/api/epp/forms/{formId}

Forms

Get a form

patch/api/epp/forms/{formId}

Forms

Update a form

delete/api/epp/forms/{formId}

Forms

Delete a form and its submissions, versions, packets, and idempotency keys

post/api/epp/forms/{formId}/clone

Forms

Duplicate a form as a new draft

post/api/epp/forms/{formId}/publish

Forms

Publish a form

get/api/epp/forms/{formId}/versions

Forms

List immutable published versions for a form

get/api/epp/forms/{formId}/submissions

Submissions

List submissions for a form

post/api/epp/forms/{formId}/submissions

Submissions

Submit a public response

post/api/epp/connectors/{packetId}/ack

Connectors

Acknowledge or fail a connector packet

get/api/epp/events

Events

List event workspaces

get/api/epp/events/{eventId}/data

Events

Get event master data and mapped records

patch/api/epp/events/{eventId}/data

Events

Update one event-data record