Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abusix.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Webhooks

Webhooks in AbuseHQ allow you to integrate with external systems by calling their API endpoints. Once configured, Webhooks can be triggered as part of a Playbook Transition.

​
Accessing Webhook Settings

To configure Webhooks:
  1. Open the Admin Portal.
  2. Click the Settings option in the left-hand menu under AbuseHQ.
  3. Select Webhooks under Integrations.
  4. Click the Add Webhook button.

​
Configuring a Webhook

When creating a webhook, fill in the following:
  • Name – A clear label for the webhook
  • Endpoint – The API endpoint to be called
  • Method – HTTP method to use (e.g., POST, PUT, PATCH)
  • Path – Path within the endpoint (if applicable)
  • Payload – The data you want to send in the request

​
Example Use Case

If you want to push values stored in a case—such as subscriber data retrieved via the subscriber resolver—you can:
  1. Retrieve a case context using:
GET https://YOUR_COMPANY.abusehq.net/api/v1/cases/{caseId}/context
  1. Access subscriber resolver data in two ways:
    • Full object: s.resolver_data
    • Individual fields: e.g., s.resolver_data.CustomerEmail
🧠 When adding subscriber data to your payload, be sure to use PQL fields, not static values.

​
Authentication Note

If you receive an Authentication Failed error:
  • Generate an API key from the Settings tab.
  • Use Bearer Authentication in your HTTP header.

​
Example Header

Authorization: Bearer YOUR_API_KEY
Once the webhook is saved, you can attach it to Playbook transitions for real-time automation.