v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Events (webhooks)

Resource event

Resource event delivered as a webhook request.

postWebhookresourceEvent

Headers

Webhook-Signaturestring

Atlar Webhook request signature. Purpose: Makes it possible for your app to verify that the webhook was sent from Atlar (authenticity), and that the message hasn't been altered (integrity). See details at https://docs.atlar.com/v2.0/docs/webhooks#webhook-security

Webhook-Request-Timestampstring date-time

Example:2022-10-11T10:13:14.000000015Z

A timestamp specifying when the HTTP request was sent (by Atlar). Purpose: Used to mitigate replay attacks. See details at https://docs.atlar.com/v2.0/docs/webhooks#webhook-security

Payload

resourcestring required

Resource name.

entityobject required

A snapshot of the resource entity, after the event / changes impacted the entity.

apiVersioninteger required

Atlar API (major) version. This toghether with the resource dictates the structure of entity.

Example payload

{
  "resource": "credit_transfers",
  "event": {
    "id": 1,
    "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
    "entityId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
    "name": "CREATED",
    "timestamp": "2022-08-20T12:20:40.866061374Z",
    "details": {
      "approvalStepId": "e741c062-19f6-46a0-be31-63dded5b0341"
    },
    "originator": "ATLAR"
  },
  "apiVersion": 2
}

Response

Return a 200 OK status to indicate that the data was received and processed successfully.