Integrations
      Back to home
      1. Knowledge Base
      2. Integrations

      How Do I... use Oneserve's Integration Events?

      Integration events allow your systems to receive real-time notifications when specific actions occur within your Oneserve platform.

      What are Integration Events?

      Integration events allow your systems to receive real-time notifications when specific actions occur within your Oneserve platform. This enables you to automatically trigger workflows in your other business systems, keep synchronised data across platforms, and build powerful automations without manual intervention.

      Business Benefits

      • Real-time Updates: Get instant notifications when appointments are created, rescheduled, or completed.
      • Automated Workflows: Trigger actions in other systems when a job status changes.
      • Data Synchronisation: Keep your systems in sync with the latest information from Oneserve.
      • Enhanced Reporting: Capture event data for custom reporting and analytics.

      How It Works

      1. Your organisation provides Oneserve with a secure URL endpoint that can receive webhook POST requests.
      2. Oneserve configures the selected event types to send to your endpoint.
      3. When events occur in Oneserve, notifications are automatically sent to your endpoint in real-time.
      4. Your system processes these notifications and takes appropriate actions.

      Technical Requirements

      • Your endpoint must be accessible from Oneserve's servers.
      • Your endpoint should respond with a 200 OK status code when successfully receiving events.
      • Your endpoint should be able to process JSON payloads.
      • We recommend implementing proper authentication for security (details provided during setup).

      Available Notification Events

      Appointment Events

      These events relate to the scheduling and status of service appointments:

      • APPOINTMENT_CANCELLED: Triggered when an appointment is cancelled.
      • APPOINTMENT_COMPLETED: Triggered when an engineer marks an appointment as complete.
      • APPOINTMENT_CREATED: Triggered when a new appointment is scheduled.
      • APPOINTMENT_FOLLOW_ON_NEEDED: Triggered when an engineer indicates additional work is required.
      • APPOINTMENT_RESCHEDULED: Triggered when an appointment time or date is changed.
      • APPOINTMENT_WORK_STARTED: Triggered when an engineer begins work on an appointment.

      Job Events

      These events relate to the lifecycle and details of jobs:
      • JOB_CANCELLED: Triggered when a job is cancelled.
      • JOB_COMPLETED: Triggered when all required work on a job is finished.
      • JOB_CREATED: Triggered when a new job is created in the system.
      • JOB_EVENT_CREATED: Triggered when a custom event is added to a job.
      • JOB_VERSIONED: Triggered when a new version of a job is created and is pending approval.
      • JOB_NOTE_CREATED: Triggered when a note is added to a job.
      • JOB_PURCHASE_ORDER_APPROVED: Triggered when a purchase order for a job is approved.
      • JOB_UPDATE_PRIORITY_CHANGED: Triggered when a job's priority level changes.
      • JOB_COSTS_UPDATED: Triggered when the costs associated with a job are modified.
      • JOB_STATUS_UPDATED: Triggered when a job moves to a different status.
      • JOB_VERSION_SUBMITTED_FOR_APPROVAL: Triggered when a job version is submitted for approval.

      Document Events

      These events relate to documentation within the system:
      • DOCUMENT_FILE_UPLOADED: Triggered when a new document is uploaded to the system.

      Implementation Process

      To implement Oneserve Integration Events for your organisation:
      1. Prepare Your Endpoint: Develop an endpoint in your system capable of receiving and processing webhook requests.
      2. Contact Oneserve Support: Reach out to your Oneserve account manager or support team to initiate setup.
      3. Provide Endpoint Details: Share your endpoint URL and select which event types you need.
      4. Test the Integration: Oneserve will work with you to test the connection and confirm events are being received.
      5. Go Live: Once testing is complete, your integration will be activated in the production environment.

      Example Use Cases

      • Automatically update your CRM when appointments are scheduled or completed
      • Trigger inventory management systems to reserve parts when jobs are created
      • Notify customers via SMS when an engineer has started work
      • Update financial systems when job costs change
      • Synchronise document management systems when new files are uploaded

      Support and Troubleshooting

      If you encounter any issues with your integration events or have questions about implementation: