ATatlar
Webhooks

Create webhook

Changed on

Create a webhook configuration.

post/platform/v2beta/webhooks

Request

Request body

urlstring required

The URL to which webhooks will be sent via HTTP POST requests in JSON format. Must use scheme https://.

aliasstring

A human-readable name for the webhook.

Example request

{
  "url": "https://example.com/my-atlar-webhooks",
  "alias": "Payment updates"
}

Response

The created webhook.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

urlstring required

The URL to which webhooks will be sent via HTTP POST requests in JSON format. Must use scheme https://.

verifiedboolean required

Webhooks requests won't be sent if the webhook configuration is not verified (by Atlar). Modifying the URL sets verified to false. You can contact support@atlar.com to get a webhook configuration verified.

aliasstring

A human-readable name for the webhook.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

Example response

{
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
  "url": "https://example.com/my-atlar-webhooks",
  "filters": [
    {
      "resource": "direct_debits",
      "apiVersion": 2
    }
  ],
  "alias": "Payment updates",
  "created": "2022-05-04T18:31:12.889104898Z",
  "updated": "2022-05-04T18:47:32.213842599Z"
}

Changes