Skip to main content
POST
/
onboarding
/
api
/
v1
/
webhooks
/
trigger
/
{webhook_id}
Trigger Webhook Event
curl --request POST \
  --url https://api.carbnconnect.com/onboarding/api/v1/webhooks/trigger/{webhook_id} \
  --header 'x-api-key: <api-key>'
{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "trigger_status": "success",
  "triggered_at": "YYYY-MM-DDTHH:MM:SS.sssZ",
  "message": "Webhook triggered successfully"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Path Parameters

​
webhook_id
string<uuid>
required

The unique identifier of the webhook to trigger

Response

Webhook triggered successfully

​
id
string<uuid>

The webhook ID that was triggered

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

​
trigger_status
enum<string>

Status of the webhook trigger attempt

Available options:
success,
failed
Example:

"success"

​
triggered_at
string<date-time>

Timestamp when the webhook was triggered

Example:

"YYYY-MM-DDTHH:MM:SS.sssZ"

​
message
string

Status message for the trigger attempt

Example:

"Webhook triggered successfully"