LogoLogo
  • Your Guide to PAVE's Account and Enterprise Dashboards
  • Enterprise Dashboard
    • Permissions and Access Settings
    • User Feature Walkthrough
      • View All Groups
        • Filtering Sessions
          • Searching Sessions
          • Advanced View
        • Exporting Sessions
      • Group Manage
        • Create New Group
        • Add Accounts to Group
        • Edit Group
      • Group Remove
      • Account Manage
        • Create New Account
        • Add User to New Account
          • User Account Permissions
        • Edit Account
        • Deactivate Account
      • Account: Switch To
      • Administrator: Manage
        • Create New Administrator
        • Edit Administrator
      • Administrator: Switch
      • Data: Manage
      • Data: Export Only
      • Data: Developer
      • Initiate Inspections (coming soon)
        • VIN Assignment
      • Create New Export Setting
        • Edit Export Settings
      • Setting Up SFTP Batches
      • Dashboard
        • Inspection Status
        • Session Exports
      • Custom Capture
  • Branch Dashboard
    • Overview
    • User Feature Walkthrough
      • Login
      • Live or Test View
      • Send Inspections
      • Inspection Status
        • Expired Sessions
      • Searching Sessions
      • Photos
      • Session Notes
      • Inspection Results
      • Condition Report PDF
      • Export Sessions
      • VIN Assignments
      • Developer Tools
        • API Keys
        • API Logs
        • Sessions Events
        • Webhooks
      • Settings
        • Account
          • Changing your password
          • Google Single sign-on
        • Branding
          • Overview
          • Logos
          • Background Colour
          • SMS Message / Results Customization
          • Customize Video
        • Users
          • Finding and Editing Users
          • Creating A New User
          • Different User Types and Permissions
          • Deactivating and Reactivating Users and Admins
          • Receive Condition Reports via Email
        • Widgets
          • Overview
          • Creating a Website Widget
            • Editing an existing Website Widget
            • Preview a Website Widget
            • Installing a Website Widget on Your Website
          • Sharable Links
            • PAVE App icon
        • Batches
        • Estimates
        • Integrations
          • vAuto
        • Custom Capture
    • Step by Step Guide
      • Managing Unique User Sessions
Powered by GitBook
On this page
Export as PDF
  1. Branch Dashboard
  2. User Feature Walkthrough
  3. Developer Tools

Webhooks

Create webhooks and get notified for supported events for all sessions relating to your API-Key through a JSON payload.

PreviousSessions EventsNextSettings

Last updated 1 year ago

Setting Up a Webhook

Step 1: Add a new Webhook on your PAVE dashboard as shown below

Step 2: Configure the settings as per your use-case and click 'Create'

Parameter
Description

API Keys

Select the API Key associated with this webhook

Callback Events

Endpoint

Add the Endpoint URL where you would like to receive the JSON associated with the Callback Event

Method

Based on your selected Callback, the API operations such as GET, POST, PUT get selected automatically. No action for the user

You can only set up one webhook event per API Key per Callback Event.

Manually Sending a Webhook

Webhooks once set, can be sent manually using the PAVE dashboard as well. This is required in cases where the webhook did not send or saw an error.

Please see the screenshot below on how to send a webhook manually:

Select the Callback Event you would like to set up. Read more about Callback Events

here
Add a Webhook
Configure a Webhook
Manually Send a Webhook