Skip to main content
PUT
Update webhook
🔄 Updatable fields:
  • Endpoint URL
  • Enabled/disabled status
  • Event subscriptions
⚠️ Important:
  • URL changes take effect immediately
  • Disabling pauses all deliveries
  • Event changes apply to future events only
💡 Common Updates:
  • Change endpoint URL
  • Enable/disable specific events
  • Temporarily pause webhook
  • Add new event types

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 update

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

Body

application/json
url
string<uri>
required

Webhook endpoint URL

Example:

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

enabled
boolean
default:true
required

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

Response

✅ Webhook updated 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