Skip to main content
POST
/
api
/
v2
/
public
/
event
/
trigger
curl -X POST "https://app.refold.ai/api/v2/public/event/trigger" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "candidate_created",
    "payload": { "jobid": "123", "email": "jane@example.com" }
  }'
{
  "message": "Webhook Fired Success"
}
Fire a custom event for a linked account. Refold validates the event exists on your default custom app, optionally validates auth on a named app slug, then enqueues the event for asynchronous workflow execution. The call returns synchronously once the event is queued.

Authentication

This endpoint fires for a specific linked account, so it accepts either authentication method. Option 1 — API key
x-api-key
string
Your Refold API key.
linked_account_id
string
The linked account the event fires for.
Option 2 — Session token
Authorization
string
Session token for the linked account.Format: Bearer YOUR_SESSION_TOKEN

Headers

slug
string
Optional app slug to validate auth against before firing.
config_id
string
Optional config to scope the trigger to.
instance_tag
string
Optional tag to label the resulting execution.

Body Parameters

event
string
required
The event name to fire. (Either event or trigger must be provided.)
trigger
string
Alias for event.
payload
object
Arbitrary JSON payload passed to the workflow.

Response

message
string
Confirmation that the event was queued.
{
  "message": "Webhook Fired Success"
}
curl -X POST "https://app.refold.ai/api/v2/public/event/trigger" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "candidate_created",
    "payload": { "jobid": "123", "email": "jane@example.com" }
  }'