Webhooks

Another way to receive data is by setting up Webhook events in your backend. Webhooks can be used to notify your systems about events as they occur in a Railz connection. Using the Railz Dashboard™, you can setup several webhook endpoints to be notified of such events.

Railz uses webhooks to notify your application when an event happens in your account. Webhooks are particularly useful for asynchronous events like when a business's accounting data has been synchronized, a new connection was created, or the posting of a transaction was successful.

📘

Setting up Webhooks in your Sandbox

You can also test webhooks without setting up your own endpoint following the instructions in Testing Webhooks in Sandbox.

Best Practices

Order of events

Railz does not guarantee the delivery of events in the order in which they are generated. For example, creating a connection might generate the following events:

  • New Connection
  • Authentication Completed
  • Data Synchronized (if connection successful)
  • Connection Disconnected

Your endpoint should not expect delivery of these events in this order and should handle this accordingly.

Security

Your server must accept HTTP POST requests and respond to each event with a 200 response, so we can have a confirmation that the transmission of the event was properly completed.

Your server must have a valid SSL certificate.