Skip to main content
POST
/
webhooks
/
simulate
Simulate a webhook event
curl --request POST \
  --url http://localhost/public/v1/webhooks/simulate \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook_id": "<string>"
}
'
{
  "ok": true,
  "payload": "<string>",
  "response": {
    "status": "<string>",
    "body": "<string>"
  },
  "delivered": "<string>"
}

Body

application/json
​
event
enum<string>
required

Required. The event type to simulate.

Available options:
email.queued,
email.sent,
email.bounced.soft,
email.bounced.hard,
email.deferred,
email.opened,
email.clicked,
email.bot.opened,
email.bot.clicked,
email.replied,
email.contact.saved,
email.contact.unsubscribed,
email.lead.created,
email.sale.created
​
webhook_id
string
required

Required. The webhook to target with the simulated payload.

Response

​
ok
boolean
required
​
payload
string
required
​
response
object
required
​
delivered
string
required