Webhooks
      Back to home
      1. Knowledge Base
      2. Public API Documentation
      3. Webhooks

      Webhook Integration Setup

      This article will address setting up Webhook Integrations.

      Creating an Integration Source

      1. Go to Integration Sources Page.
        1. Available under the Rates drop-down
        2. Available under the LSP drop-down
      2. Select the option Add New Integration Source
      3. Enter any Source Description
        1. This will be the naming convention associated with the integration.
          1. Recommended - "Public API Webhooks - [Your Company Name]
      4. Select a Source Type
        1. Choose the option Public API Webhooks
      5. Ensure Owner Org is set to your Accounting Organization
      6. Username and Password
        1. Fill these fields in with credentials that would be used to communicate with the API Endpoint
        2. If Authorization Token is required, use the SourceSetting - Authorization
      7. Select Save & View Details at the top right
      8. After the Integration Source has been saved, add the Linked Organization
        1. This will determine which shipments will get sent over.
        2. If you add a Linked Organization for an Office, all shipments where that Office is part of could trigger the Webhook.
      9. Add in the Source Setting with the Value you want included as the trigger.
        • ShipmentCreateUrl - Sends shipment details data on shipment creation.
        • ShipmentDetailUpdateUrl- Sends Shipment Details data on shipment updates (this includes status, shipment information, address, commodity, etc).
        • ShipmentLocationUpdateUrl: Sends simplified shipment data based on location updates, but will only trigger if the last update was more than 15 minutes ago.
        • ShipmentLocationUpdateExtendedUrl: Sends detailed shipment data based on location updates, triggering only if the last update was more than 15 minutes ago.
        • BillCreateUrl - Sends bill data with Approve Bill workflow.
        • InvoiceCreateUrl - Sends invoice data when the invoice creation is completed.
        • InvoiceCreateWithShipmentUrl - Sends invoice and shipment data when the invoice creation is completed.
        • CustomerCreateUrl - Sends customer details data on customer creation.
        • CustomerUpdateUrl - Sends customer details data on customer updates.
        • LSPCarrierCreateUrl - Sends carrier details data on carrier creation.
        • LSPCarrierUpdateUrl - Sends carrier details data on carrier updates.
        • Additional Settings under Source Setting.
          • Authorization - If your webhook URL requires an authorization token, you can add it with this setting.
          • DoNoMarkInvoiceAsPrinted - When the value of this parameter is true, the invoice will show up in the Invoice Delivery screen. Otherwise, it will be marked as Printed on the day it was sent.
          • Version - By Default the system will use the latest version of the API Integration, if you need to specify a version, you can add it here. (As of right now we have Versions 1 and 2)