Skip to main content
GET
/
account
/
webhook
/
{webhook_id}
Get Webhook
curl --request GET \
  --url https://api.sendpost.io/api/v1/account/webhook/{webhook_id} \
  --header 'X-Account-ApiKey: <api-key>'
{
  "id": 117,
  "enabled": true,
  "url": "https://app.hooli.com/email/webhook",
  "processed": true,
  "delivered": true,
  "dropped": false,
  "softBounced": false,
  "hardBounced": true,
  "opened": true,
  "clicked": true,
  "unsubscribed": true,
  "spam": true,
  "sent": true,
  "smtpDropped": false,
  "uniqueOpen": true,
  "uniqueClick": true,
  "created": 1567512491588004000,
  "created_by": {
    "id": 117,
    "isVerified": true,
    "isForbidden": false,
    "firebaseUID": "1234567890",
    "email": "[email protected]",
    "name": "Raj",
    "url": "https://www.sendpost.io/logo.png",
    "companyName": "SendPost",
    "onboardQAnswered": true,
    "phoneNumber": "+919876543210",
    "notesColor": "#000000",
    "created": 1567512491588004000
  },
  "updated_by": {
    "id": 117,
    "isVerified": true,
    "isForbidden": false,
    "firebaseUID": "1234567890",
    "email": "[email protected]",
    "name": "Raj",
    "url": "https://www.sendpost.io/logo.png",
    "companyName": "SendPost",
    "onboardQAnswered": true,
    "phoneNumber": "+919876543210",
    "notesColor": "#000000",
    "created": 1567512491588004000
  }
}

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 ID of the webhook to retrieve.

Example:

117

Response

200 - application/json

Webhook details.

​
id
integer

Unique ID for the webhook.

Example:

117

​
enabled
boolean

Indicates if the webhook is active or paused.

Example:

true

​
url
string

URL endpoint to which webhook calls need to be made.

Example:

"https://app.hooli.com/email/webhook"

​
processed
boolean

Trigger webhook on email message being processed.

Example:

true

​
delivered
boolean

Trigger webhook on email message being delivered.

Example:

true

​
dropped
boolean

Trigger webhook on email message being dropped.

Example:

false

​
softBounced
boolean

Trigger webhook on email message being soft bounced.

Example:

false

​
hardBounced
boolean

Trigger webhook on email message being hard bounced.

Example:

true

​
opened
boolean

Trigger webhook on email message being opened.

Example:

true

​
clicked
boolean

Trigger webhook on email message link being clicked.

Example:

true

​
unsubscribed
boolean

Trigger webhook on email message being unsubscribed.

Example:

true

​
spam
boolean

Trigger webhook on email message being marked as spam.

Example:

true

​
sent
boolean

Trigger webhook on email message being sent.

Example:

true

​
smtpDropped
boolean

Trigger webhook on email message being dropped by SMTP.

Example:

false

​
uniqueOpen
boolean

Trigger webhook on unique email opens.

Example:

true

​
uniqueClick
boolean

Trigger webhook on unique email clicks.

Example:

true

​
created
integer<int64>

UNIX epoch nano timestamp when the webhook was created.

Example:

1567512491588004000

​
created_by
object

Member who created the webhook

​
updated_by
object

Member who updated the webhook