Skip to main content
Webhooks are managed from Settings > Webhooks in your workspace.

​
Creating a webhook

1

Open webhook settings

Go to Settings > Webhooks and click Add Webhook.
2

Configure the endpoint

Fill in the webhook details:
  • URL — The HTTPS endpoint that will receive deliveries
  • Name — A friendly label (e.g., “Production CMS Sync”)
  • Description — What this webhook is used for (optional)
3

Choose events

Select one or more event types to subscribe to. See the Event Catalog for details on each event.
4

Save and copy the signing secret

After saving, your signing secret is displayed once. Copy it and store it securely — you’ll need it to verify signatures.
Create webhook form

Create a new webhook endpoint from Settings > Webhooks

The signing secret is only shown in full when you first create the webhook. After that, only the last 4 characters are visible. If you lose it, delete the webhook and create a new one.

​
Viewing your webhooks

The webhooks list shows each endpoint’s status, subscribed events, and error rate at a glance.
Webhook list view

Webhook list showing status, events, and error rate

​
Editing a webhook

Click on any webhook to update its URL, name, description, or event subscriptions.
Edit webhook form

Edit webhook settings and event subscriptions

When updating events, the entire subscription list is replaced. Make sure all the events you want are selected.

​
Enabling and disabling

Toggle a webhook’s status directly from the webhook detail page:
  • Enable — Reactivates the webhook and resets the failure counter to 0
  • Disable — Pauses all deliveries until re-enabled
Use disable instead of delete if you want to temporarily pause deliveries. You can re-enable at any time without losing your configuration or delivery history.

​
Deleting a webhook

Click Delete to remove a webhook. Any pending deliveries in the queue will be skipped.
Deletion cannot be undone. If you might need the webhook again, disable it instead.

​
Sending a test event

Before going live, verify your endpoint by sending a test delivery.
1

Open the webhook

Go to Settings > Webhooks and click on the webhook you want to test.
2

Send a test

Choose an event type and click Send Test Event.
3

Check the result

The test delivery appears in the delivery log with a Test badge. Confirm your server received and processed it.
Send test event dialog

Send a test event to verify your endpoint

Test deliveries:
  • Have is_test: true in the payload
  • Are marked with a Test badge in the delivery history
  • Work even when the webhook is disabled
  • Use sample payloads with zeroed UUIDs (00000000-0000-0000-0000-000000000000)

​
Webhook statuses

When a webhook reaches 10 consecutive failures, DeepSmith automatically disables it to protect your endpoint. Re-enable it from the platform after fixing the underlying issue.