Skip to main content
GET
List Webhooks

Authorizations

X-Account-ApiKey
string
header
required

This api key can be used for all account level operations

Query Parameters

limit
integer

Number of records to return per request.

Example:

10

offset
integer

Number of initial records to skip.

Example:

0

Case insensitive search against webhook URL.

Example:

"hooli"

Response

200 - application/json

A list of webhooks.

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 | null

Member who created the webhook

updated_by
object | null

Member who updated the webhook