ATatlar
Webhooks

Update webhook

Changed on

Update webhook configuration. Modifying /url sets verified to false. You can contact support@atlar.com to get a webhook configuration verified. Changes may take up to 10 minutes until they are in full effect.

If the webhook was created via API v1, it can't be patched; replace it with a new one using POST /v2beta/webhooks instead. The new webhook starts unverified, and has no signing key until you create one with POST /v2beta/webhooks/{id}/keys.

patch/platform/v2beta/webhooks/{id}

Request

Path parameters

idstring required

Atlar resource ID.

Request body

Example request

[
  {
    "value": "https://example.com/my-atlar-webhooks"
  }
]

Response

The updated 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