Get a Webhook via the API

Retrieve a single AhaSend webhook by ID with the API, including its URL, subscribed event types, enabled status and domain scope.

GET /v2/accounts/{account_id}/webhooks/{webhook_id}

AhaSend Go SDK

Go

package main

import (
  "context"
  "fmt"
  "log"

  "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.GetWebhook(
    ctx,
    accountID,
    uuid.MustParse("c5a32c40-b351-439f-8230-779daed3e42c"),
    nil,
  )
  if err != nil {
    log.Fatalf("Error getting webhook: %v", err)
  }

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

200

{
  "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"
}

The AhaSend API returns a specific webhook by ID. Access requires the global read role or a read role matching at least one associated domain.

Related Guides

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

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

webhook_id · string<uuid> · required

Webhook ID

Response

200

application/json

Webhook details

object · enum<string> · required

Object type identifier

Available options: webhook

id · string<uuid> · required

Unique identifier for the webhook

created_at · string<date-time> · required

When the webhook was created

updated_at · string<date-time> · required

When the webhook was last updated

name · string · required

Webhook name

url · string<uri> · required

Webhook URL

enabled · boolean · required

Whether the webhook is enabled

on_reception · boolean · required

Trigger on message reception

on_delivered · boolean · required

Trigger on message delivery

on_transient_error · boolean · required

Trigger on transient errors

on_failed · boolean · required

Trigger on permanent failures

on_bounced · boolean · required

Trigger on bounces

on_suppressed · boolean · required

Trigger on suppressions

on_opened · boolean · required

Trigger on opens

on_clicked · boolean · required

Trigger on clicks

on_suppression_created · boolean · required

Trigger on suppression creation

on_dns_error · boolean · required

Trigger on DNS errors

scope · enum<string> · required

Webhook scope

Available options: global, scoped

domains · string[] · required

Domains this webhook applies to. Always present; global webhooks return an empty array.

success_count · integer · required

Number of successful calls

Required range: x >= 0

error_count · integer · required

Number of unsuccessful calls

Required range: x >= 0

errors_since_last_success · integer · required

Number of consecutive failed calls. Reset to zero by the next successful call.

Required range: x >= 0

last_request_at · string<date-time> | null · required

When the webhook was last called