Everest icon

Everest

Interact with Everest TMS (Transport Management System)
Join our community

Actions55

Overview

The node provides integration with the Everest Transport Management System (TMS) specifically for managing webhook subscriptions. The Webhook - Unsubscribe operation allows users to remove a previously registered webhook URL from receiving notifications about specific events in the Everest system.

This is useful when you no longer want to receive updates or notifications for certain events, such as mission status changes, client updates, or invoice creations. For example, if your application was listening for "Mission Created" events but you want to stop receiving those notifications, you would use this operation to unsubscribe the webhook URL from that event.

Practical scenarios include:

  • Cleaning up webhook subscriptions when an integration is decommissioned.
  • Managing dynamic webhook URLs that change over time.
  • Controlling which events your system listens to by unsubscribing from irrelevant ones.

Properties

Name Meaning
Webhook URL The URL endpoint that was previously subscribed and should be unsubscribed from receiving notifications. Example: https://yourhookurl.com/0m9p8znha20i21iwu4e2b2ba283
Event The specific event type to unsubscribe from. Options include a wide range of events such as:
- Backend Auth
- User Created / Updated / Deleted
- Mission Created / Updated / Deleted / Cancelled / Finished / Failed / Success / Picked Up / Dispatched / Status Changed / Rescheduled / Price Updated / Imported
- Client Created / Updated / Deleted / Tariffs Updated / API Updated
- Agent Created / Updated / Location Updated / Deleted / File Created / Updated / Deleted
- Invoice Created / Updated / Deleted
- Refund Created
- Contact Created / Updated / Deleted
- Comment Created / Updated
- Service Created / Updated
- Status Created / Updated
- Vehicle Created / Updated
- Platform Global Settings Updated / Invoicing Updated
- Area of Service Created / Updated
- Tariff Policy Updated
- Dispatch Rules Updated
- Role Created / Updated
- Availabilities Updated
- Establishment Created / Updated / Deleted
- Form Created / Updated
- Support Email Sent

Output

The output of the operation is a JSON array containing the result of the unsubscribe request(s). Typically, it will confirm successful unsubscription or provide error details if the operation failed.

The structure generally includes:

  • Confirmation of the webhook URL and event unsubscribed.
  • Any relevant metadata or status messages returned by the Everest API.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Everest TMS API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The node depends on internal helper functions to make HTTP POST requests to the Everest API endpoints related to webhook management.

Troubleshooting

  • Common issues:

    • Providing an incorrect or malformed webhook URL may cause the unsubscribe request to fail.
    • Attempting to unsubscribe from an event that the webhook URL is not subscribed to might return an error or no effect.
    • Network connectivity issues or invalid API credentials will prevent successful communication with the Everest API.

  • Error messages:

    • Errors indicating authorization failure suggest checking the API key or token configuration.
    • Validation errors about missing or invalid parameters indicate ensuring the webhook URL and event are correctly specified.
    • If the node returns an error message about the event or URL not found, verify that the webhook subscription exists before attempting to unsubscribe.

Links and References

Note: This summary is based solely on static analysis of the provided source code and property definitions without runtime execution or external API inspection.

Discussion