Get started
Before you start
Section titled “Before you start”- You need a program owner or super admin account in the Accountable dashboard.
- You need an HTTPS endpoint that accepts
POSTrequests from the public internet.
Add a webhook
Section titled “Add a webhook”-
In the dashboard, open Account, then the Webhooks tab.
-
Select Add Webhook.
-
Enter your endpoint URL and choose the Events you want. Description is optional.
-
Save. Copy the secret that appears and store it somewhere safe. You need it to verify signatures.
Handle the request
Section titled “Handle the request”Your endpoint should:
- Read the raw request body before parsing it.
- Verify the signature.
- Return a
2xxstatus within 30 seconds. - Do slow work after responding.
The same event can arrive more than once. Use the X-YAA-Webhook-Id header to skip events you have already handled. See Delivery and retries.
Manage a webhook
Section titled “Manage a webhook”Open the menu (⋮) next to a webhook.
| Action | What it does |
|---|---|
| View Event Logs | Shows each event sent to this endpoint, with its status and response. You can retry a failed event here. |
| Show Secret | Shows the current secret. |
| Edit | Changes the URL, events, description or active status. The secret stays the same. |
| Rotate Secret | Creates a new secret. The old secret stops working right away. |
| Delete | Removes the webhook. |
Test before production
Section titled “Test before production”Ask us for a staging account and test your endpoint there first. Email integrations@youareaccountable.com.