Get Event

Get a single custom event from your org’s default app.

GET /api/v2/public/application/event/:event_id

cURL

curl -X GET "https://app.refold.ai/api/v2/public/application/event/{event_id}" \
  -H "x-api-key: YOUR_API_KEY"

200

{
  "_id": "6a314123d0aeb8165be4f175",
  "name": "candidate_created",
  "response": [
    { "key": "event", "type": "text" },
    { "key": "payload", "type": "object" },
    { "key": "payload.email", "type": "text" }
  ]
}

Retrieve a single custom event (trigger) from your organization’s default custom application by its ID.

Authentication

Events are defined at the org level, so this endpoint uses API-key auth.

x-api-key · string · required

Your Refold API key. Find it in Settings → Credentials.

Path Parameters

event_id · string · required

The event ID.

Example: 6a314123d0aeb8165be4f175

Response

200 OK

_id · string

Event ID.

name · string

Event name.

response · array

Parsed payload field map ({key, type}).

404 Not Found

status_code · integer

HTTP status code.

http_error_type · string

Error category.

error · string

Internal error code.

message · string

Human-readable error description.

200

{
  "_id": "6a314123d0aeb8165be4f175",
  "name": "candidate_created",
  "response": [
    { "key": "event", "type": "text" },
    { "key": "payload", "type": "object" },
    { "key": "payload.email", "type": "text" }
  ]
}

cURL

curl -X GET "https://app.refold.ai/api/v2/public/application/event/{event_id}" \
  -H "x-api-key: YOUR_API_KEY"