Skip to main content
POST
/
external
/
v1
/
automations
/
webhooks
/
{public_id}
/
fire
Fire Webhook Trigger
curl --request POST \
  --url https://api.example.com/external/v1/automations/webhooks/{public_id}/fire/

​
Fire Webhook Trigger

Trigger a Firstwork automation by sending data to its webhook endpoint. This allows external systems to initiate automations in Firstwork.

​
Endpoint

POST /external/v1/automations/webhooks/{public_id}/fire/

​
Path Parameters

ParameterTypeRequiredDescription
public_idstring (UUID)YesThe webhook trigger’s public ID

​
Request Body

The request body can contain any JSON data. The payload is mapped to the automation’s input variables based on its configuration.

​
Example Request

curl -X POST "https://your-instance.firstwork.com/external/v1/automations/webhooks/a1b2c3d4-e5f6-7890-abcd-ef1234567890/fire/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "background_check_complete",
    "candidate_email": "john.doe@example.com",
    "result": "passed",
    "check_type": "criminal",
    "completed_at": "2025-01-20T15:00:00Z",
    "details": {
      "provider": "sterling",
      "case_id": "STR-12345"
    }
  }'

​
Example Response

{
  "status": "success",
  "data": {
    "execution_id": "exec-uuid-here",
    "automation": "Process Background Check Result",
    "status": "triggered"
  }
}

​
Error Responses

CodeDescription
401Invalid API key
404Webhook trigger not found
400Invalid request body

​
Notes

  • The automation executes asynchronously — the response confirms the trigger was received, not that the automation completed
  • Use the execution ID to track the automation’s progress
  • The webhook payload fields should match the automation’s expected input variables
  • Webhook triggers can be rate-limited to prevent abuse