Skip to main content
GET
/
webhook
Get all webhooks
curl --request GET \
  --url https://api.sendx.io/api/v1/rest/webhook \
  --header 'X-Team-ApiKey: <api-key>'
[
  {
    "id": "webhook_iqj3OR6VbjaO2fohm72MYy",
    "enabled": true,
    "url": "https://api.example.com/webhooks/all",
    "unsubscribed": true,
    "dropped": true,
    "bounced": true,
    "markedSpam": true,
    "clicked": true,
    "opened": true,
    "contactCreated": true,
    "created": 1705750200
  },
  {
    "id": "webhook_kQJ17si7GhhaKDsPxyXLxY",
    "enabled": false,
    "url": "https://api.example.com/webhooks/engagement",
    "unsubscribed": false,
    "dropped": false,
    "bounced": false,
    "markedSpam": false,
    "clicked": true,
    "opened": true,
    "contactCreated": false,
    "created": 1705663800
  }
]
📊 Response includes:
  • Webhook ID with prefix
  • Endpoint URL
  • Enabled status
  • Event subscriptions
  • Creation timestamp

Authorizations

​
X-Team-ApiKey
string
header
required

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

Example:

X-Team-ApiKey: your_team_api_key_here

Response

✅ Webhooks 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

⌘I