API Reference
These docs are for v1. Click to read the latest docs for v2.

Webhook requests towards your server

post
https://api.atlar.com/your/chosen/path

The actual webhook events sent to your server from the Atlar platform, should you have configured webhooks. The path and domain is configured via the Create webhook endpoint.

Body Params

The webhook payload

entity
object
required

The entity itself as it looked right after the event impacted it. This entity is of the same model as found on the regular API. I.e. if the resource is direct_debits, this entity will be of the same model as the DirectDebit model

event
object
string
required

The impacted entity's resource name

Response
200

OK

Updated 3 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 3 months ago

Did this page help you?