Integration

Important: If you integrate with our services, you must accept and sign our Integration agreement.

We support three main methods of integrations: API, Webhooks and File.

API

• Simple request/response REST API calls.
• Usually supports low quantities of data and handles requests in a synchronous way.
• The operations/endpoints/contracts are described directly in each service API, with examples of requests/responses.
• Endpoints are secured using AAD certificates.
• Before integrating, review our API integration recommendations.
• We recommend enabling distributed tracing for your integration, to help us troubleshoot any issues you may encounter. See Distributed tracing for more information.

Webhook

• Simple HTTP webhook callbacks.
• Webhook payload contracts are described directly in each service API. Look for the webhooks definition in the top right dropdown of each Swagger.
• Payloads will typically contain the minimum amount of data needed for the receiving end to follow up on the event.
• Payloads are signed with an HMAC SHA256 signature. Webhook signature validation.

File

• Used for large amounts of data (100+ rows of data).
• Used for:
  • Import: Client sends data to us.
  • Export: Client listens to data changes/events in our systems.

Please note that not every service of ours necessarily supports every type of integration. More information about integration support for each service can be found in the details provided for that particular service.