Skip to main content
GET
Get Webhook

Authorizations

X-Account-ApiKey
string
header
required

This api key can be used for all account level operations

Path Parameters

webhook_id
integer
required

The unique ID of the webhook to retrieve.

Example:

117

Response

200 - application/json

Webhook configuration details.

Webhook configuration for receiving real-time email event notifications. When events occur (delivery, open, click, bounce, etc.), SendPost sends HTTP POST requests to your configured webhook URL.

Best Practices:

  • Use HTTPS endpoints for security
  • Respond with 2xx status within 10 seconds
  • Implement idempotency using eventId
  • Verify webhook signatures (see documentation)
id
integer<int64>

Unique identifier for the webhook configuration

Example:

117

enabled
boolean

Whether the webhook is active. When false, no events will be sent to this webhook. Useful for temporarily pausing notifications during maintenance.

Example:

true

url
string<uri>

HTTPS endpoint URL to receive webhook POST requests. Must be publicly accessible and return 2xx status code.

Example:

"https://app.hooli.com/api/webhooks/sendpost"

processed
boolean

Trigger webhook when an email is accepted for processing. Fires immediately when API call is successful.

Example:

true

sent
boolean

Trigger webhook when an email is sent to the recipient's mail server. Indicates the email left SendPost's infrastructure.

Example:

true

dropped
boolean

Trigger webhook when an email is dropped before sending. Common reasons: suppressed address, invalid email, unverified domain.

Example:

true

smtpDropped
boolean

Trigger webhook when an email is dropped at SMTP level. Usually due to policy rejection by receiving server.

Example:

false

delivered
boolean

Trigger webhook when an email is successfully delivered. Note: "Delivered" means accepted by mail server, not inbox placement.

Example:

true

softBounced
boolean

Trigger webhook on temporary delivery failure (soft bounce). SendPost will retry delivery automatically.

Example:

true

hardBounced
boolean

Trigger webhook on permanent delivery failure (hard bounce). The recipient is automatically added to suppression list.

Example:

true

opened
boolean

Trigger webhook when recipient opens the email. Fires on every open (can fire multiple times per email).

Example:

true

clicked
boolean

Trigger webhook when recipient clicks a link. Fires on every click (can fire multiple times per email).

Example:

true

unsubscribed
boolean

Trigger webhook when recipient clicks the unsubscribe link. The recipient is automatically added to suppression list.

Example:

true

spam
boolean

Trigger webhook when recipient marks email as spam. The recipient is automatically added to suppression list. Monitor this closely - high spam rates damage sender reputation.

Example:

true

uniqueOpen
boolean

Trigger webhook only on the first open of an email (unique opens). Use this instead of 'opened' if you only care about unique engagement.

Example:

false

uniqueClick
boolean

Trigger webhook only on the first click of an email (unique clicks). Use this instead of 'clicked' if you only care about unique engagement.

Example:

false

status
enum<string>

Health status of the webhook (read-only):

  • active - delivering normally
  • degraded - recent delivery failures
  • disabled - auto-disabled after repeated consecutive failures
Available options:
active,
degraded,
disabled
Example:

"active"

disabledAt
integer<int64>

UNIX epoch timestamp in nanoseconds when the webhook was auto-disabled (0 if never). Read-only.

Example:

0

disabledReason
string

Human-readable reason the webhook was auto-disabled (empty if active). Read-only.

Example:

""

created
integer<int64>

UNIX epoch timestamp in nanoseconds when the webhook was created

Example:

1704067200000000000