We offer a variety of event types to which you can subscribe. Each event type comes with a specific payload that helps you determine the triggering condition of the event (e.g., if an order is created, from which fund it originates). Upon receiving an event and its payload, you can make additional calls to our REST APIs or GraphQL to gather more information.

Example

  1. New order created event

By receiving fundId and orderId, you can use REST or GraphQL as your preference to retrieve the details. For example, if you want to query the main contact of the created order, you can achieve that by using our GraphQL

{
  getOrder(id: "ORDER-ID") {
    mainContact {
	    id
	    email
	    firstName
	    lastName
    }
  }
}
  1. New file uploaded

By receiving the fileId, you can use the REST API to generate a download URL for that file, or retrieve the name through GraphQL.