For the complete documentation index, see llms.txt. This page is also available as Markdown.

Event Webhook

List all webhooks for an event

get
Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
eventIdstringRequired
Responses
200

Success

application/json
get/public-api/v1/event/{eventId}/webhook/all
GET /public-api/v1/event/{eventId}/webhook/all HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "dataList": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "url": "text",
      "actions": [
        "attendee-create"
      ],
      "rawData": {
        "url": "text",
        "actions": [
          "attendee-create"
        ]
      }
    }
  ]
}

Create a webhook subscription for an event

post

Configure a URL to receive attendee lifecycle events.

When a matching action fires, EventX sends an HTTP POST to your endpoint with this payload:

{
  "config": {
    "event_id": "95b71478-c7dd-4bbd-b65b-244a63d3e689",
    "webhook_id": "59acba79-1ff4-4ade-8e74-6491e73e2d28",
    "action": "attendee-update",
    "endpoint_url": "https://hooks.example.com/webhook"
  },
  "attendee": {
    "id": "a2f46cf1-6787-45a2-bb8b-08cc6d6114d2",
    "first_name": "angussdf",
    "last_name": "luk",
    "firstName": "angussdf",
    "lastName": "luk",
    "name": "angus luk nw1k",
    "email": "attendee@example.com",
    "registration_status": "registered",
    "virtual_attendance_status": "pending",
    "first_entered_web_app_at": null,
    "magic_link_url": "https://portal.eventx.io/magic-link/00000000-0000-0000-0000-000000000000/authorize",
    "attendance_type": "pending",
    "role_tags": [
      "visitor"
    ],
    "ticket_class_id": null,
    "ticket_class_name": null,
    "job_title": "manager",
    "organization": "eventx",
    "city": null,
    "country": "HK",
    "area_code": "852",
    "contact_no": "51234567",
    "source": null,
    "created_at": "2026-07-30T01:46:33.487Z",
    "update_at": "2026-07-30T01:48:16.845Z",
    "attended_at": null,
    "registered_at": "2026-07-30T01:46:33.487Z",
    "checked_in_at": null,
    "custom_fields": {},
    "check_in_method": null
  }
}

Your server must respond with any 2xx status to acknowledge receipt.
Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
eventIdstring · uuidRequired
Body
urlstringRequired
Responses
200

Success

application/json
post/public-api/v1/event/{eventId}/webhook
POST /public-api/v1/event/{eventId}/webhook HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "url": "text",
  "actions": [
    "attendee-create"
  ]
}
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "url": "text",
    "actions": [
      "attendee-create"
    ],
    "rawData": {
      "url": "text",
      "actions": [
        "attendee-create"
      ]
    }
  }
}

Permanently delete a webhook

delete

Hard delete. The webhook is permanently removed from the database.

Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
eventIdstring · uuidRequired
webhookIdstring · uuidRequired
Responses
200

Success

application/json
objectOptional
delete/public-api/v1/event/{eventId}/webhook/{webhookId}
DELETE /public-api/v1/event/{eventId}/webhook/{webhookId} HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Accept: */*
{}

Partially update a webhook

patch
Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
eventIdstring · uuidRequired
webhookIdstring · uuidRequired
Body
urlstringOptional
Responses
200

Success

application/json
patch/public-api/v1/event/{eventId}/webhook/{webhookId}
PATCH /public-api/v1/event/{eventId}/webhook/{webhookId} HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "url": "text",
  "actions": [
    "attendee-create"
  ]
}
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "url": "text",
    "actions": [
      "attendee-create"
    ],
    "rawData": {
      "url": "text",
      "actions": [
        "attendee-create"
      ]
    }
  }
}

Last updated