curl "https://api.telzino.com/v1/webhook-event-types" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
const response = await fetch('https://api.telzino.com/v1/webhook-event-types', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
}
});
import requests
response = requests.get(
'https://api.telzino.com/v1/webhook-event-types',
headers={'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}
)
{ "data": [ {
"event_type": "account.first_agent_created", "flat_name": "agent_created", "levels": ["account"], "category": "onboarding",
"description": "The account created its first agent while on its trial (once per account, ever).", "data_fields": ["agent_name", "agent_extension"], "settings_schema": null, "settings_from": null
}, {
"event_type": "org.call_volume_spike", "flat_name": null, "levels": ["account", "reseller", "organization"], "category": "monitoring",
"description": "The organization's calls in the last hour exceeded the configured number.", "data_fields": ["threshold", "observed", "since", "inbound_calls", "outbound_calls"],
"settings_schema": { "fields": { "calls_per_hour": { "type": "integer", "min": 1, "max": 100000, "required": true } } }, "settings_from": null
} ] }
{ "error": "invalid_request", "error_description": "level must be account, reseller or organization" }
Event Webhooks
List Event Types
The catalogue of events an endpoint can subscribe to
GET
/
v1
/
webhook-event-types
curl "https://api.telzino.com/v1/webhook-event-types" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
const response = await fetch('https://api.telzino.com/v1/webhook-event-types', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
}
});
import requests
response = requests.get(
'https://api.telzino.com/v1/webhook-event-types',
headers={'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}
)
{ "data": [ {
"event_type": "account.first_agent_created", "flat_name": "agent_created", "levels": ["account"], "category": "onboarding",
"description": "The account created its first agent while on its trial (once per account, ever).", "data_fields": ["agent_name", "agent_extension"], "settings_schema": null, "settings_from": null
}, {
"event_type": "org.call_volume_spike", "flat_name": null, "levels": ["account", "reseller", "organization"], "category": "monitoring",
"description": "The organization's calls in the last hour exceeded the configured number.", "data_fields": ["threshold", "observed", "since", "inbound_calls", "outbound_calls"],
"settings_schema": { "fields": { "calls_per_hour": { "type": "integer", "min": 1, "max": 100000, "required": true } } }, "settings_from": null
} ] }
{ "error": "invalid_request", "error_description": "level must be account, reseller or organization" }
Query Parameters
See also the Events guide page.settings_from is null except on agent.activity_resumed, org.activity_resumed and agent.registration_restored, where it names the event whose settings they use (agent.inactive, org.inactive, agent.registration_lost). settings_schema is null for events without settings. Otherwise fields maps each setting name to { "type": "integer", "min", "max", "required" } or { "type": "business_hours", "required" } (event settings).
curl "https://api.telzino.com/v1/webhook-event-types" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
const response = await fetch('https://api.telzino.com/v1/webhook-event-types', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
}
});
import requests
response = requests.get(
'https://api.telzino.com/v1/webhook-event-types',
headers={'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}
)
{ "data": [ {
"event_type": "account.first_agent_created", "flat_name": "agent_created", "levels": ["account"], "category": "onboarding",
"description": "The account created its first agent while on its trial (once per account, ever).", "data_fields": ["agent_name", "agent_extension"], "settings_schema": null, "settings_from": null
}, {
"event_type": "org.call_volume_spike", "flat_name": null, "levels": ["account", "reseller", "organization"], "category": "monitoring",
"description": "The organization's calls in the last hour exceeded the configured number.", "data_fields": ["threshold", "observed", "since", "inbound_calls", "outbound_calls"],
"settings_schema": { "fields": { "calls_per_hour": { "type": "integer", "min": 1, "max": 100000, "required": true } } }, "settings_from": null
} ] }
{ "error": "invalid_request", "error_description": "level must be account, reseller or organization" }