Skip to main content
WEBHOOK
AhaSend sends this event when a contact reports a campaign email as spam: a membership’s subscription status becomes complained, or a complaint about a campaign sent to a segment is recorded for the campaign’s recipient. data.complaint is the spam complaint report, as on message.complained, and data.campaign_id is the campaign of the reported email. For a membership, data.previous_subscription_status is the status before the change. A recipient of a campaign sent to a segment who reports it as spam unsubscribes from all lists, so the event has data.list and data.list_contact set to null, and data.segment_id is the segment. This event is sent also when the contact is already unsubscribed, once for each campaign that the contact reports. data.contact.unsubscribed says whether the contact is unsubscribed from all lists after the complaint. No event: A complaint about a membership that is already complained. Setting: on_contact_complained (Contact Reported Spam in the dashboard). Requirements:
  • Your account has the marketing features. Contact events cannot be turned on without them.
  • A webhook with this event on needs an API key with contacts:read and lists:read when you create or update it through the API. See contact events.
When it’s sent: When a spam complaint about a campaign email changes the contact’s membership of the campaign’s list, or is recorded for a recipient of a campaign sent to a segment.

Body

application/json
type
enum<string>
required

The event type

Available options:
contact.complained
webhook_id
string<uuid>
required

The webhook ID (the same ID as returned by the Create Webhook API)

timestamp
string<date-time>
required

When the change happened (ISO 8601 format)

data
object
required

Response

Webhook received successfully