Webhooks API
Webhooks send AgencyMax events to your HTTPS endpoint as they happen, for example when an agent is created or updated. You don't have to poll. Use the Webhooks API to manage subscriptions and inspect delivery history.
| Current version | v1 |
| Base path | /webhooks/{tenantIdentifier} |
| Scopes | read:webhook-subscriptions, write:webhook-subscriptions |
| Reference | API Portal |
caution
Upcoming scope renames
These scopes are expected to be renamed to webhooks:subscriptions:read and webhooks:subscriptions:write. Changes will be announced in the Release Notes.
How it works
- Subscriptions: create and manage subscriptions.
- Receiving webhooks: payload format, signature verification and retries.
- Event types: the events you can subscribe to.