Skip to main content
GET
AhaSend Go SDK
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.

Authorizations

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

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_unsubscribed
boolean
required

Trigger on unsubscribes

on_complained
boolean
required

Trigger on spam complaints

on_suppression_created
boolean
required

Trigger on suppression creation

on_suppression_deleted
boolean
required

Trigger on suppression deletion

on_dns_error
boolean
required

Trigger on DNS errors

on_contact_created
boolean
required

Trigger on contact creation

on_contact_updated
boolean
required

Trigger on contact updates

on_contact_deleted
boolean
required

Trigger on contact deletion

on_contact_added_to_list
boolean
required

Trigger when a contact is added to a list

on_contact_removed_from_list
boolean
required

Trigger when a contact is removed from a list

on_contact_subscribed
boolean
required

Trigger when a contact subscribes

on_contact_unsubscribed
boolean
required

Trigger when a contact unsubscribes

on_contact_complained
boolean
required

Trigger when a contact reports spam

origins
enum<string>[] | null
required

The origins of the contact and suppression events that the webhook gets, or null for every origin. Message events and domain.dns_error have no origin, and the webhook always gets them.

Who made a change that a contact or suppression event reports: recipient for the contact or recipient, through an unsubscribe link, a one-click unsubscribe, or a spam complaint; api for you, through the AhaSend API; dashboard for you, through the AhaSend dashboard; system for AhaSend, for example after a bounce, an expired message or an email validation, or when AhaSend support makes the change.

Available options:
recipient,
api,
dashboard,
system
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