GET
/
v2
/
accounts
/
{account_id}
/
webhooks
Get Webhooks
curl --request GET \
  --url https://api.ahasend.com/v2/accounts/{account_id}/webhooks \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "object": "webhook",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "url": "<string>",
      "enabled": true,
      "on_reception": true,
      "on_delivered": true,
      "on_transient_error": true,
      "on_failed": true,
      "on_bounced": true,
      "on_suppressed": true,
      "on_opened": true,
      "on_clicked": true,
      "on_suppression_created": true,
      "on_dns_error": true,
      "scope": "<string>",
      "domains": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJpZCI6MTIzNH0="
  }
}

Authorizations

Authorization
string
header
required

API key for authentication

Path Parameters

account_id
string<uuid>
required

Account ID

Query Parameters

enabled
boolean

Filter by enabled status

on_reception
boolean

Filter by reception event trigger

on_delivered
boolean

Filter by delivery event trigger

on_transient_error
boolean

Filter by transient error event trigger

on_failed
boolean

Filter by failure event trigger

on_bounced
boolean

Filter by bounce event trigger

on_suppressed
boolean

Filter by suppression event trigger

on_opened
boolean

Filter by open event trigger

on_clicked
boolean

Filter by click event trigger

on_suppression_created
boolean

Filter by suppression creation event trigger

on_dns_error
boolean

Filter by DNS error event trigger

limit
integer
default:100

Maximum number of items to return (1-100)

Required range: 1 <= x <= 100
cursor
string

Pagination cursor for the next page

Response

200
application/json

List of webhooks

The response is of type object.