Setting Up a Webhook

Before you start

Prepare a publicly reachable HTTPS URL that accepts JSON POST requests. The endpoint must verify Astalty signatures, return a 2xx response within 15 seconds and handle repeat deliveries safely.

The Account Owner can manage webhooks. An Admin also needs Can manage API keys and webhooks. See Grant API Key and Webhook Access.

Open the Webhooks area

1. Open Settings.
2. Select API Dashboard.
3. Select Webhooks.

Create a webhook

1. Select Create Webhook.
2. Enter a Description that identifies the receiving system or purpose.
3. Enter the public HTTPS endpoint in URL.
4. Leave Enabled selected to receive events after creation. Clear it if the endpoint is not ready.
5. Under Event Types, select at least one supported event.
6. Select Create.

Copy your signing secret

After creation, Astalty opens the webhook detail page and shows its Signing Secret. Store this secret in the receiving system's secrets manager and use it to verify each delivery.

The Signing Secret cannot be changed. If it is exposed, archive the webhook and create a replacement with a new secret.

Manage an existing webhook

Select a row in the Webhooks table to open its detail page. From there you can:

• Select Edit to change the Description, URL, Enabled state or Event Types.
• Clear Enabled to pause new deliveries while keeping the configuration.
• Select Actions > Archive to stop using the webhook and remove it from the active list.
• Use the Status filter on the Webhooks page to find an archived webhook, then open it and select Actions > Unarchive to restore it.

Review delivery logs

The Deliveries section lists each event Astalty has sent to the webhook. Select a delivery to inspect:

• its event type, delivery ID, URL, status and payload
• the creation time, last attempt and next scheduled retry
• each attempt's status, response time, failure reason, headers and response body when available

The Retry action is available after a delivery is Failed or Delivered. Retrying a delivered item sends it again, so make sure the receiving system can handle the same delivery ID more than once. See Webhook Retries and Delivery for the automatic schedule.