Introduction
The Webhook system has been designed to mitigate the necessity for Fivaldi partners to constantly poll Fivaldi's APIs for updates on customer data. Fivaldi webhooks documentation can be found here.
Through the use of Webhooks, Fivaldi offers partners notifications about specific Events within Fivaldi, including changes in customer data. These events are categorized into various predefined EventTypes.
Partners can set up a Webhook to subscribe to one or multiple EventTypes. This way, partners will receive notifications about the events of the selected EventTypes, specifically those related to customers whose data they have the permission to access.
Overview
Partners can retrieve a list of EventTypes available for subscription by making a GET request to the EventTypes API. After identifying the desired EventType(s), they can subscribe to them by establishing a Webhook through a POST request to the Webhook API. Upon successful Webhook creation, partners will begin receiving notifications for the subscribed events at the URL specified in their Webhook configuration.
Event notification will include a payload, there are two options for this:
- For certain event types the payload will contain complete information about the event
- For other event types the payload can be significantly large, thus partners are required to fetch the full content by calling a Fivaldi API.This applies for following event types:
- Purchase Invoice Create -> InvoiceID in event notification payload
- Purchase Invoice Change -> InvoiceID in event notification payload
- Chart Of Accounts Change -> empty payload in event notification payload
Authentication
Authentication for these Fivaldi APIs is done with Partner API authentication, as detailed here.
Oliko tästä vastauksesta apua? Kyllä Ei
Send feedback