Table of Contents

Webhook Events: Overview

Mitchell Ivany Updated by Mitchell Ivany

Read Time: 12 mins

In Sonar, webhook events allow external systems to be notified when supported activity occurs, such as when an account is created, a payment is made, or a ticket is updated.

Technically, a webhook sends an HTTP POST request with a JSON payload to a URL you configure. The payload includes event data that the receiving system can use to complete an action or update its own records.

What is a Webhook?

A webhook is a way for one system to automatically notify another system when an event happens.

Instead of one system repeatedly checking Sonar to ask whether anything has changed, Sonar can send a message as soon as the event occurs. This makes webhooks useful for real-time updates, integrations, and automation.

Why Use Webhooks?

Webhooks are useful because they allow systems to react quickly and efficiently.

They can help:

  1. Send real-time updates when something changes in Sonar.
  2. Reduce the need to constantly check an API for new activity.
  3. Automate workflows between Sonar and external tools.
  4. Support custom integrations that are not built directly into the platform.

For example, when a customer account is created in Sonar, a webhook can notify another system so the customer can be added to a CRM, email marketing platform, or provisioning system.

Simple Analogy

Polling is like checking your mailbox every 10 minutes to see if a package arrived.

A webhook is like the delivery driver ringing your doorbell when the package shows up.

Webhook Events

Webhook events are grouped by category below. Each webhook includes a brief description of the platform activity that triggers it.

Accounts & Customer Data

  1. Account Billing Parameters: Triggers when billing parameters are changed on an account, such as billing day or due day.
  2. Account Calix Service Details: Triggers when Calix service details are added, modified, or removed on an account.
  3. Account Events: Triggers when account-level activity occurs, such as activation, deactivation, status changes, type changes, group changes, or service changes.
  4. Account Groups: Triggers when account groups are created, modified, or removed.
  5. Account Services: Triggers when services are added, modified, or removed from an account.
  6. Account Statuses: Triggers when account status definitions are created, modified, or removed.
  7. Account Types: Triggers when account type definitions are created, modified, or removed.
  8. Accounts: Triggers when customer accounts are created, modified, or removed. This can also trigger when a child account is attached to or detached from an account.
  9. Adjustment Service Details: Triggers when adjustment service details are created, modified, or removed.
  10. Companies: Triggers when company records are created, modified, or removed.
  11. Contacts: Triggers when contacts are created, modified, or removed from customer accounts.
  12. Data Service Details: Triggers when data service details are created, modified, or removed.
  13. Expiring Service Details: Triggers when expiring service details are created, modified, or removed.
  14. Overage Service Details: Triggers when overage service details are created, modified, or removed.
  15. Package Services: Triggers when services within packages are created, modified, or removed.
  16. Recurring Service Details: Triggers when recurring service details are created, modified, or removed.
  17. Scheduled Event Account Voice Service Details: Triggers when a scheduled event is created to add voice service details to an account.
  18. Voice Service Details: Triggers when voice service details are created, modified, or removed.

Addresses & Geography

  1. Address Lists: Triggers when address lists are created, modified, or removed.
  2. Addresses: Triggers when serviceable addresses are created or removed.
  3. Future Serviceable Addresses: Triggers when future serviceable addresses are created, modified, or removed.
  4. Geofences: Triggers when Geofences are created, modified, or removed.
  5. Local Prefixes: Triggers when local prefixes are created, modified, or removed.
  6. Serviceable Address Assignments: Triggers when a serviceable address is assigned to or unassigned from an account.

Alerting & Reporting

  1. Alerting Rotation Days: Triggers when alerting rotation days are created, modified, or removed.
  2. Alerting Rotations: Triggers when alerting rotations are created, modified, or removed.
  3. FCC Data Exports: Triggers when FCC data exports are created or removed.

Billing & Payments

  1. ACH Batches: Triggers when ACH batches are created, modified, or deleted.
  2. Bank Account Processor Credentials: Triggers when bank account processor credentials are created, modified, or removed.
  3. Bank Account Processors: Triggers when bank account processors are created, modified, or removed.
  4. Bank Accounts: Triggers when customer bank accounts are created, modified, or removed.
  5. Billing Cycle Completions: Triggers when Sonar processes customers that need to be billed during the billing cycle task.
  6. Billing Defaults: Triggers when billing defaults are created, modified, or removed.
  7. Billing Settings: Triggers when billing settings are created, modified, or removed.
  8. Credit Card Processor Credentials: Triggers when credit card processor credentials are created, modified, or removed.
  9. Credit Card Processors: Triggers when credit card processors are created, modified, or removed.
  10. Credit Cards: Triggers when customer credit cards are created, modified, or removed.
  11. Credits: Triggers when credits are created, modified, or removed from customer accounts.
  12. Data Usage Histories: Triggers when historical data usage records are created, modified, or removed.
  13. Data Usage Top-Offs: Triggers when data usage top-off services are added to a customer account.
  14. Debits: Triggers when debits are created, modified, or removed from customer accounts.
  15. Delinquency Exclusions: Triggers when delinquency exclusions are created, modified, or removed.
  16. Deposit Slips: Triggers when deposit slips are created, modified, or removed.
  17. Discounts: Triggers when discounts are created, modified, or removed.
  18. General Ledger Codes: Triggers when general ledger codes are created, modified, or removed.
  19. Geo Tax Zones: Triggers when geo tax zones are created, modified, or removed.
  20. Invoice Attachments: Triggers when invoice attachments are created, modified, or removed.
  21. Invoice Messages: Triggers when invoice messages are created, modified, or removed.
  22. Invoices: Triggers when invoices are created, modified, or removed on customer accounts.
  23. Paypal Credentials: Triggers when PayPal credentials are created, modified, or removed.
  24. Payments: Triggers when customer payments are created, modified, or removed.
  25. Printed Invoice Batches: Triggers when printed invoice batches are created or removed.
  26. Refunded Payments: Triggers when refunded payment records are created, modified, or removed.
  27. Reversed Payments: Triggers when reversed payment records are created, modified, or removed.
  28. Service Taxes: Triggers when taxes applied to services are created, modified, or removed.
  29. Tax Overrides: Triggers when tax overrides are created, modified, or removed on customer accounts.
  30. Tax Transactions: Triggers when tax calculation transactions are created, modified, or removed.
  31. Taxes: Triggers when tax definitions are created, modified, or removed.
  32. Usage Based Billing Policies: Triggers when usage based billing policies are created, modified, or removed.
  33. Usage Based Billing Policy Free Periods: Triggers when usage based billing policy free periods are created, modified, or removed.

Communications & Tickets

  1. Agreement Templates: Triggers when agreement templates are created, modified, or removed.
  2. Agreements: Triggers when agreements are added to or removed from an account.
  3. Call Logs: Triggers when call logs are created, modified, or removed.
  4. Canned Replies: Triggers when canned replies are created, modified, or removed.
  5. Canned Reply Categories: Triggers when canned reply categories are created, modified, or removed.
  6. Categories: Triggers when inventory model categories are created, modified, or removed.
  7. Email Clicks: Triggers when an email click event is recorded.
  8. Email Domains: Triggers when email domains are created, modified, or removed.
  9. Email Locations: Triggers when email location activity is recorded.
  10. Email Messages: Triggers when email messages are created, modified, or removed.
  11. Email Opens: Triggers when an email open event is recorded.
  12. External Marketing Provider Credentials: Triggers when external marketing provider credentials are created, modified, or removed.
  13. External Marketing Providers: Triggers when external marketing providers are created, modified, or removed.
  14. Handwritten Signatures: Triggers when a customer signs an agreement or document using a generated signing link.
  15. Inbound Mailboxes: Triggers when inbound mailboxes are created, modified, or removed.
  16. Mass Messages: Triggers when mass messages are created, modified, or removed.
  17. Messaging Categories: Triggers when messaging categories are created, modified, or removed.
  18. Notes: Triggers when notes are created, modified, or removed on entities in the instance.
  19. Saved Message Contents: Triggers when saved email message content is created, modified, or deleted.
  20. Saved Messages: Triggers when saved email messages are created, modified, or deleted.
  21. SMTP Events: Triggers when SMTP-related email events are recorded.
  22. Ticket Categories: Triggers when ticket categories are created, modified, or removed.
  23. Ticket Comments: Triggers when ticket comments are created, modified, or removed.
  24. Ticket Groups: Triggers when ticket groups are created, modified, or removed.
  25. Ticket Recipients: Triggers when ticket recipients are created, modified, or removed.
  26. Ticket Replies: Triggers when ticket replies are created, modified, or removed.
  27. Tickets: Triggers when tickets are created, modified, or removed.
  28. Triggered Messages: Triggers when triggered messages are created, modified, or removed.

Custom Data & Miscellaneous

  1. Custom Field Data Items: Triggers when data contained in custom fields is created, modified, or removed.
  2. Custom Fields: Triggers when custom fields are created, modified, or removed.
  3. Disconnection Logs: Triggers when disconnection logs are created on a customer account.
  4. Files: Triggers when files are created, modified, or removed anywhere in the instance.
  5. Model Field Data: Triggers when data contained in inventory model fields is created, modified, or removed.
  6. Model Fields: Triggers when inventory model fields are created, modified, or removed.
  7. Recent Items: Triggers when recent items are created.
  8. Service Metadata: Triggers when service metadata fields are created, modified, or removed.
  9. Service Metadata Values: Triggers when service metadata values are created, modified, or removed.
  10. Services: Triggers when services are created, modified, or removed.
  11. Packages: Triggers when packages are created, modified, or removed.

Inventory

  1. Consumable Inventory Items: Triggers when consumable inventory items are created, modified, consumed, or removed.
  2. Deployment Types: Triggers when deployment types are created, modified, or removed.
  3. Generic Inventory Assignees: Triggers when generic inventory assignees are created, modified, or removed.
  4. Generic Inventory Item Action Logs: Triggers when actions occur on generic inventory items, such as assignment or consumption.
  5. Internal Locations: Triggers when internal locations are created, modified, or removed.
  6. Inventory Item Events: Triggers when inventory item events occur, such as deletion or assignee changes.
  7. Inventory Items: Triggers when inventory items are created, modified, or removed.
  8. Inventory Locations: Triggers when inventory locations are created, modified, or removed.
  9. Inventory Models: Triggers when inventory models are created, modified, or removed.
  10. Manufacturers: Triggers when manufacturers are created, modified, or removed.
  11. Purchase Order Items: Triggers when purchase order items are created, modified, attached, detached, or deleted.
  12. Purchase Orders: Triggers when purchase orders are created, modified, completed, or removed.
  13. Uninventoried MAC Addresses: Triggers when uninventoried MAC addresses are created, modified, or removed.
  14. Vendor Items: Triggers when vendor items are created, modified, or removed.
  15. Vendors: Triggers when vendors are created, modified, or removed.

Jobs & Field Service

  1. GPS Tracking Provider Credentials: Triggers when GPS tracking provider credentials are created, modified, or removed.
  2. GPS Tracking Providers: Triggers when GPS tracking providers are created, modified, or removed.
  3. Job Check Ins: Triggers when a technician checks in to an assigned job.
  4. Job Services: Triggers when services attached to a scheduled job are created, modified, or removed.
  5. Job Types: Triggers when job types are created, modified, or removed.
  6. Jobs: Triggers when jobs are created, modified, or removed.
  7. Schedule Addresses: Triggers when schedule addresses are created, modified, or removed.
  8. Schedule Availabilities: Triggers when schedule availabilities are created, modified, or removed.
  9. Schedule Availability Day & Times: Triggers when schedule availability day and time records are created, modified, or removed.
  10. Schedule Blocker Day & Times: Triggers when schedule blocker day and time records are created, modified, or removed.
  11. Schedule Blocker Overrides: Triggers when schedule blocker overrides are created.
  12. Schedule Blockers: Triggers when schedule blockers are created, modified, or removed.
  13. Schedule Time Offs: Triggers when scheduled time off records are created, modified, or removed.
  14. Scheduled Events: Triggers when scheduled events are created, modified, or removed.
  15. Task Template Items: Triggers when task template items are created, modified, or removed.
  16. Task Templates: Triggers when task templates are created, modified, or removed.
  17. Tasks: Triggers when tasks are created, modified, or removed.
  18. Vehicle Location Updates: Triggers when vehicle location updates are recorded.
  19. Vehicles: Triggers when vehicles are created, modified, or removed.

Networking & Provisioning

  1. DHCP Server Credentials: Triggers when DHCP server credentials are created, modified, or removed.
  2. DHCP Server Identifiers: Triggers when DHCP server identifiers are created, modified, or removed.
  3. DHCP Servers: Triggers when DHCP servers are created, modified, or removed.
  4. Inline Device Credentials: Triggers when inline device credentials are created, modified, or removed.
  5. Inline Devices: Triggers when inline devices are created, modified, or removed.
  6. IP Assignment Histories: Triggers when historical IP assignment records are created, modified, or removed.
  7. IP Assignments: Triggers when IP assignments are created, modified, or removed on devices, locations, or accounts.
  8. IP Pools: Triggers when IP pools are created, modified, or removed.
  9. LTE EPCS: Triggers when LTE EPC records are created, modified, or removed.
  10. LTE Provider Credentials: Triggers when LTE provider credentials are created, modified, or removed.
  11. LTE Providers: Triggers when LTE providers are created, modified, or removed.
  12. Netflow Allowed Subnets: Triggers when Netflow allowed subnets are created, modified, or removed.
  13. Netflow Endpoints: Triggers when Netflow endpoints are created, modified, or removed.
  14. Netflow Whitelists: Triggers when Netflow whitelists are created, modified, or removed.
  15. Network Monitoring Graphs: Triggers when network monitoring graphs are created, modified, or removed.
  16. Network Monitoring Templates: Triggers when network monitoring templates are created, modified, or removed.
  17. Network Sites: Triggers when network sites are created, modified, or removed.
  18. Poller Settings: Triggers when poller settings are changed.
  19. Pollers: Triggers when pollers are created, modified, or removed.
  20. Preseem Settings: Triggers when Preseem integration settings are changed.
  21. RADIUS Accounts: Triggers when RADIUS accounts are created, modified, or removed.
  22. RADIUS Group Reply Attributes: Triggers when RADIUS group reply attributes are created, modified, or removed.
  23. RADIUS Groups: Triggers when RADIUS groups are created, modified, or removed.
  24. RADIUS Server Credentials: Triggers when RADIUS server credentials are created, modified, or removed.
  25. RADIUS Servers: Triggers when RADIUS servers are created, modified, or removed.
  26. RADIUS Session Histories: Triggers when RADIUS session history records are created, modified, or removed.
  27. SNMP OID Thresholds: Triggers when SNMP OID thresholds are created, modified, or removed as part of a network monitoring template.
  28. SNMP OIDS: Triggers when SNMP OIDs are created, modified, or removed as part of a network monitoring template.
  29. SNMP Overrides: Triggers when SNMP overrides are created, modified, or removed.
  30. SNMP Threshold Violations: Triggers when SNMP threshold violations are created, modified, or removed.
  31. Subnets: Triggers when subnets or IP addresses are created, modified, or removed.
  32. Supernets: Triggers when supernets are created, modified, or removed.

Users, Roles & System

  1. Application Firewall Rules: Triggers when application firewall rules are created, modified, or removed.
  2. Editor Licenses: Triggers when editor licenses are created, modified, assigned, or removed.
  3. Password Policies: Triggers when password policies are created, modified, or removed.
  4. Personal Access Tokens: Triggers when personal access tokens are created, modified, or removed on employee accounts.
  5. Roles: Triggers when roles are created, modified, or removed.
  6. Sonar Support Access Requests: Triggers when Sonar Support access requests are created, modified, or removed.
  7. System Settings: Triggers when system settings are modified.
  8. User Preferences: Triggers when users modify their user preferences.
  9. Users: Triggers when users are created, modified, or removed.
  10. Webhook Endpoints: Triggers when webhook endpoints are created, modified, or deleted.
  11. Webhook Events: Triggers when another webhook event occurs.

Voice

  1. Phone Number Types: Triggers when phone number types are created, modified, or removed.
  2. Phone Numbers: Triggers when phone numbers are created, modified, or removed from customer contacts.

How did we do?

Contact