Getting Started
Subscribing
Create and manage event subscriptions via the Management API
Subscribing to Events
Event subscriptions are managed through the Management API under the /v1/{tenantCode}/account/event-subscriptions endpoints. Each subscription targets a specific event type, a destination URL, and an authentication method.
Quick example
POST /v1/{tenantCode}/account/event-subscriptions
Authorization: Bearer <token>
Content-Type: application/json
{
"eventType": "orderCreated",
"destination": "https://your-system.com/webhooks/avvyr",
"enabled": true,
"authType": "hmac",
"hmacSecret": "your-secret-key",
"retryEnabled": true,
"retryCount": 3,
"comment": "Order sync to ERP"
}
What you can configure
| Field | Description |
|---|---|
eventType | Which event to listen for (e.g. orderCreated, productUpdated) |
destination | Your webhook URL |
authType | How Avvyr authenticates with your endpoint: none, basic, bearer, or hmac |
retryEnabled / retryCount | Automatic retry on delivery failure |
errorEmail | Get notified when deliveries fail |
additionalHeaders | Custom headers sent with every webhook |
Available operations
- Create a subscription
- List all subscriptions
- Get a specific subscription
- Update a subscription (e.g. disable it, change auth)
- Delete a subscription
- Search by event type, destination, or comment
- Test — send a synthetic event to verify your endpoint
Permissions
| Action | Permission |
|---|---|
| Create | EVENT_SUBSCRIPTIONS.CREATE |
| Read / List / Search | EVENT_SUBSCRIPTIONS.READ |
| Update / Test | EVENT_SUBSCRIPTIONS.UPDATE |
| Delete | EVENT_SUBSCRIPTIONS.DELETE |
See the Management API Reference for full request/response schemas, field definitions, and try requests live.
Always use the test endpoint after creating a subscription to verify that your endpoint is reachable, auth is correct, and your system handles the payload.