Managing Webhooks in Portal¶

Use Business Settings → Developers → Webhooks to manage webhook subscriptions for your merchant account. Prepare your receiving endpoint before creating a webhook; see Receiving Events for the HTTP request and acknowledgment requirements.

Payload version 2 availability

Payload version 2 is documented in advance. Availability depends on activation for your integration. Contact Blackstone support before using it. The controls available in your account may differ from those shown in this guide.

Open the Webhooks section¶

Open Business Settings, select Developers, and open Webhooks. This section lists the webhook subscriptions configured for the account.

Webhooks tab under Developers, showing the subscription list and Create Webhook button

Create a webhook¶

Select Create Webhook and complete the configuration.

Create Webhook form with endpoint, description, attempts, token expiration, status, payload version, and event selection

Setting	What to enter or select
Endpoint URL	The HTTPS endpoint in your application that will receive webhook requests.
Description	A label or description that helps you recognize the purpose of the subscription.
Payload version	The payload format your endpoint supports and that is available for your integration. See the reference for versions 1 and 2.
Events	The notifications you want the subscription to receive. Select at least one event. The legacy `Sale` subscription groups transaction notifications; in version 2, `Sale` covers only that endpoint, so select other sale events individually when needed.
Status	Active enables the subscription; Inactive leaves it disabled. The creation form starts with Inactive selected.
Attempts	The maximum total number of delivery attempts, from 1 to 10, including the initial request. 1 means no retries. Higher values allow retries for failures eligible under the delivery policy.
Token expiration	The expiration date carried by the generated token. This is not a scheduled deactivation date for the webhook.

Token expiration does not disable the subscription

Reaching the token expiration date does not automatically change the webhook to Inactive or stop deliveries. Manage the subscription through its Status setting.

Save and store the token¶

Review the endpoint URL, payload version, events, status, and attempt limit, then select Create Webhook.

After successful creation, Portal closes the creation form, displays the generated token, and refreshes the webhook list. Copy the token and store it securely for the server that receives your webhooks. Treat it as a credential: keep it out of client-side code, screenshots, and application logs.

Configure webhook authentication for your integration before enabling the subscription. If your receiver is not ready, keep the subscription Inactive while you complete the setup.

Review an existing subscription¶

Return to the Webhooks list to review the configuration and use the subscription's editing controls when changes are needed. Check the endpoint, selected events, status, and attempt limit before saving changes.

For payload examples, use the webhook reference. To prepare your receiver and handle repeated notifications, follow Receiving Events.