List Webhooks

curl --request GET \
  --url https://api.sendpost.io/api/v1/account/webhook \
  --header 'X-Account-ApiKey: <api-key>'

const options = {method: 'GET', headers: {'X-Account-ApiKey': '<api-key>'}};

fetch('https://api.sendpost.io/api/v1/account/webhook', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sendpost.io/api/v1/account/webhook",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Account-ApiKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sendpost.io/api/v1/account/webhook"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Account-ApiKey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sendpost.io/api/v1/account/webhook")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Account-ApiKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": 117,
    "enabled": true,
    "url": "https://app.hooli.com/api/webhooks/sendpost",
    "processed": false,
    "sent": false,
    "dropped": true,
    "smtpDropped": false,
    "delivered": true,
    "softBounced": true,
    "hardBounced": true,
    "opened": true,
    "clicked": true,
    "unsubscribed": true,
    "spam": true,
    "uniqueOpen": false,
    "uniqueClick": false,
    "created": 1704067200000000000,
    "status": "active",
    "disabledAt": 0,
    "disabledReason": "",
    "successRate": 99.5
  }
]

Webhook

List Webhooks

Retrieve all configured webhooks for your account. Webhooks enable real-time notifications when email events occur, allowing you to build reactive applications.

Supported Events:

Event	Description
`processed`	Email accepted and queued for delivery
`dropped`	Email blocked (suppressed, invalid, policy)
`delivered`	Email successfully delivered to recipient
`hardBounced`	Permanent delivery failure
`softBounced`	Temporary delivery failure
`opened`	Recipient opened the email (all opens)
`uniqueOpened`	First open per recipient only
`clicked`	Recipient clicked a link (all clicks)
`uniqueClicked`	First click per recipient only
`unsubscribed`	Recipient unsubscribed
`spam`	Recipient marked email as spam

Use Cases:

Audit configured webhook endpoints
Verify webhook URLs are correct
Review enabled events per webhook
Debug webhook delivery issues

GET

account

webhook

List Webhooks

curl --request GET \
  --url https://api.sendpost.io/api/v1/account/webhook \
  --header 'X-Account-ApiKey: <api-key>'

const options = {method: 'GET', headers: {'X-Account-ApiKey': '<api-key>'}};

fetch('https://api.sendpost.io/api/v1/account/webhook', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sendpost.io/api/v1/account/webhook",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Account-ApiKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sendpost.io/api/v1/account/webhook"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Account-ApiKey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sendpost.io/api/v1/account/webhook")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Account-ApiKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": 117,
    "enabled": true,
    "url": "https://app.hooli.com/api/webhooks/sendpost",
    "processed": false,
    "sent": false,
    "dropped": true,
    "smtpDropped": false,
    "delivered": true,
    "softBounced": true,
    "hardBounced": true,
    "opened": true,
    "clicked": true,
    "unsubscribed": true,
    "spam": true,
    "uniqueOpen": false,
    "uniqueClick": false,
    "created": 1704067200000000000,
    "status": "active",
    "disabledAt": 0,
    "disabledReason": "",
    "successRate": 99.5
  }
]

Authorizations

X-Account-ApiKey

string

header

required

This api key can be used for all account level operations

Query Parameters

limit

integer

default:20

Number of records to return per request. Default 20.

Example:

10

offset

integer

default:0

Number of initial records to skip for pagination.

Example:

0

string

Case insensitive search against webhook URLs.

Example:

"api.yoursite.com"

Response

200 - application/json

List of configured webhooks, each with its delivery success rate.

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

successRate

number<double>

Percentage of webhook deliveries that succeeded (2xx responses) over the recent measurement window. Ranges from 0 to 100.

Example:

99.5

API Reference

Email

Domain

Stats

Suppression

IP

Message

IPPools

Stats (A)

Sub-Account

Webhook

List Webhooks

Authorizations

Query Parameters

Response