Send platform events to webhooks

Open the receiver in your browser (here http://localhost:8091). It creates a session with a unique URL;

Note the session ID, the last part of the URL;

Build the address that Core Hub must call: the host and port that Core Hub uses to reach the receiver, followed by the session ID. For webhook-tester that is http://webhook-tester:8080/<session-id>;.

Select the Settings gear icon in the header;

Select Notifications;

Select the Webhooks tab;

Select Add webhook.

Keep Webhook enabled selected;

Select Include exception stack trace in payload (error/critical events) if the receiver should get the stack trace of failures;

In Name, enter a label for the list and for the delivery logs. This guide uses Alerts demo webhook;

In Endpoint URL, enter the address of the receiver;

In Signing secret (optional), enter a secret if the receiver must verify that a request comes from Core Hub. This guide uses a dummy value;

In Description (optional), enter a note for your colleagues.

In Objects filters, select a Pipeline, Group, or Entity to restrict the webhook to those objects. This guide selects the pipeline Alerts demo. With the three filters empty, events from every object are delivered;

In Enabled events, open the list and tick the event types to deliver. This guide ticks Entity Snapshot Started, Entity Snapshot Completed, Entity CDC Started, Entity CDC Stopped, Pipeline Error, and Pipeline Error Resolved. Select Select all or Clear to change every entry at once;

In Severity filter, tick Critical, Info, and Warning.

Select Add header;

In Header name, enter X-Demo-Source, and in Value, enter alerts-demo. Core Hub adds every header you define to each request. It ignores the reserved names X-Gluesync-Event, X-Gluesync-Delivery, X-Gluesync-Signature, Host, Content-Length, and Content-Type;

Leave Skip TLS verification cleared. Select it only for an HTTPS endpoint with a self-signed or internal certificate that the Core Hub trust store does not know;

Select Send test;

Scroll up to the top of the Webhooks tab.

Scroll down to the end of the form;

Select Create webhook.

In the receiver, select the request that arrived;

Review the HTTP headers. Select Show all headers if the list is cut;

Review the request body.

Open the pipeline and select the play icon in the row of a paused entity;

In the start dialog, keep Where it stopped and select Start entity;

Wait a few seconds, then select the pause icon in the same row;

In the Pause customers dialog, select Pause entity.

In your database tool, connect to the target database of the test pipeline and run:

ALTER TABLE shop_alerts.customers
  ADD CONSTRAINT alerts_demo_block CHECK (false) NOT VALID;

In the Control Plane, select the play icon of the paused entity;

In the start dialog, select Full copy, keep Keep and merge, and select Start entity;

Wait about 20 seconds and review the receiver.

In your database tool, run:

ALTER TABLE shop_alerts.customers
  DROP CONSTRAINT alerts_demo_block;

Watch the receiver and the entity row.

In Settings, open Notifications and the Webhooks tab;

Scroll to Delivery logs;

Compare the rows with the requests that the receiver got. Select Refresh to load the latest attempts.

Select Add webhook and enter Alerts demo unreachable as the Name and http://webhook-tester:9/unreachable as the Endpoint URL, an address where nothing listens;

Scope it to the pipeline Alerts demo, tick Entity CDC Started and Entity CDC Stopped, tick all three severities, and select Create webhook;

Pause and start the entity again, as before;

Wait about 10 seconds and select Refresh under Dead letters;

Open the temporary webhook with its pencil icon, replace the Endpoint URL with the working address of your receiver, and select Save changes;

In Dead letters, select Retry in each row.