Skip to main content
GET
Get webhook by ID

Authorizations

X-Team-ApiKey
string
header
required

Team API key for authentication. Find your API key in SendX Settings → Team API Key.

Example:

Path Parameters

identifier
string
required

Webhook identifier to retrieve

Pattern: ^(webhook_)?[a-zA-Z0-9]{22}$

Response

✅ Webhook retrieved successfully

id
string
Example:

"webhook_9l154iiXlZoPo7vngmamee"

url
string<uri>

Webhook endpoint URL

Example:

"https://api.example.com/webhooks/sendx"

enabled
boolean
default:true

Whether webhook is enabled

unsubscribed
boolean
default:false

Trigger webhook when a contact unsubscribes

dropped
boolean
default:false

Trigger webhook when an email is dropped

bounced
boolean
default:false

Trigger webhook when an email bounces

markedSpam
boolean
default:false

Trigger webhook when an email is marked as spam

clicked
boolean
default:false

Trigger webhook when a link in the email is clicked

opened
boolean
default:false

Trigger webhook when an email is opened

contactCreated
boolean
default:false

Trigger webhook when a new contact is created