List Webhooks via the API

List the webhooks in your AhaSend account with the API, filtered by enabled status or event type, with cursor pagination of up to 100 items per page.

GET /v2/accounts/{account_id}/webhooks

AhaSend Go SDK

Go

package main

import (
  "context"
  "fmt"
  "log"

  "github.com/AhaSend/ahasend-go"
  "github.com/AhaSend/ahasend-go/api"
  "github.com/google/uuid"
)

func main() {
  // Create API client with authentication
  client := api.NewAPIClient(
    api.WithAPIKey("aha-sk-your-64-character-key"),
  )

  accountID := uuid.New()

  // Create context for the API call
  ctx := context.Background()

  // Call the ping endpoint
  response, httpResp, err := client.WebhooksAPI.GetWebhooks(
    ctx,
    accountID,
    api.GetWebhooksParams{
      Limit: ahasend.Int32(100),
    },
    nil,
  )
  if err != nil {
    log.Fatalf("Error getting webhooks: %v", err)
  }

  // Check response
  if httpResp.StatusCode == 200 {
    fmt.Printf("✅ Status: %d\n", httpResp.StatusCode)
    if response != nil {
      fmt.Printf("Found %d webhooks\n", len(response.Data))
    }
  } else {
    fmt.Printf("❌ Unexpected status code: %d\n", httpResp.StatusCode)
  }
}

200

{
  "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": "global",
      "domains": [
        "<string>"
      ],
      "success_count": 1,
      "error_count": 1,
      "errors_since_last_success": 1,
      "last_request_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJpZCI6MTIzNH0="
  }
}

The AhaSend API returns a list of webhooks for the account.

The global read role sees all webhooks. Domain-scoped read roles return only webhooks associated with at least one authorized domain.

Query Parameters:

• enabled: Filter by enabled status
• Event filters: on_reception, on_delivered, on_transient_error, on_failed, on_bounced, on_suppressed, on_opened, on_clicked, on_suppression_created, on_dns_error
• limit: Maximum number of items to return (1-100, default: 100)
• after: Pagination cursor for the next page
• before: Pagination cursor for the previous page

Related Guides

• API authentication, Permission scopes, Webhook setup.
• Event reference, Webhook CLI, Local webhook testing.
• Signature verification, Retry policy, API errors.
• API rate limits, Suppression durations.

Authorizations

BearerAuthBearerAuth

Authorization · string · header · required

API key for authentication. Non-empty Security Requirement values are AhaSend API-key roles. Roles listed within one requirement object are jointly required; separate requirement objects are alternatives.

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

after · string

Pagination cursor for the next page. Provide the value provided in next_cursor from the response.

before · string

Pagination cursor for the previous page.

Response

200

application/json

List of webhooks

object · enum<string> · required

Object type identifier

Available options: list

data · object[] · required

Array of webhooks

Show child attributes

pagination · object · required

Show child attributes

Example:

{
  "has_more": true,
  "next_cursor": "eyJpZCI6MTIzNH0="
}