Skip to main content

Setup Webhook

Create a webhook subscription for each event your application needs to receive, then validate incoming requests before processing them.

Open Webhooks Settings

In the Guardhouse admin dashboard, open Settings and select Webhooks.

Click Add Webhook to create a new webhook subscription.

Guardhouse Webhooks settings page

Enter Endpoint URL

In Endpoint URL, enter the target server webhook URL that should receive Guardhouse webhook requests.

Use the full absolute URL for your receiver endpoint.

Guardhouse Add new webhook dialog with Endpoint URL

Select Event

In Event, select the webhook event type that should trigger this webhook.

For example, choose User Created to send a webhook when a user is created, or User Updated to send a webhook when a user is updated.

Guardhouse Add new webhook dialog with Event dropdown

Configure Retries And Delivery Mode

In Number of Retries, enter how many times Guardhouse should retry delivery after an unsuccessful response or transport error.

In Retry Interval (sec), enter the number of seconds Guardhouse should wait between retry attempts.

Choose the Delivery Mode:

ModeBehavior
AsynchronousRecommended. Guardhouse queues the webhook delivery and does not wait for the receiver before continuing event processing.
SynchronousGuardhouse sends the webhook during event processing and waits for delivery processing to finish, including configured retries, before continuing.

Guardhouse Add new webhook dialog with retries and delivery mode

Save Client Secret

Click Add to create the webhook subscription.

After the webhook is created, open the webhook Settings tab and copy the Client Secret.

warning

The webhook client secret is shown only once. Copy it immediately and store it in secure secret storage.

If you lose the secret, rotate it to generate a new one. Rotating the secret breaks signature validation until your receiver is updated.

Use this secret in your SDK or webhook endpoint implementation to validate the X-Hub-Signature header before processing events.

Guardhouse webhook Settings tab with one-time client secret warning

Enable Webhook

New webhook subscriptions are created disabled.

After your receiver endpoint is deployed, configured with the client secret, and ready to validate incoming signatures, enable the webhook.

From the webhook list, open the row actions menu and select Enable.

Guardhouse Webhooks table with Enable action

Review Delivery Logs

Open the webhook details page to review delivery logs.

Each log entry shows the event, delivery status, timestamp, request body, and response body. Use these logs to troubleshoot receiver errors, failed deliveries, and unexpected responses.

Guardhouse webhook log details with request and response body

Configuration

Webhook subscriptions use these settings:

FieldDescription
Target URLAbsolute URL that receives Guardhouse webhook requests.
EventGuardhouse event type delivered to the subscription.
Number of retriesNumber of delivery retry attempts.
Retry intervalDelay between retry attempts, in seconds.
Delivery modeDelivery mode configured for the subscription.

Secret

Guardhouse provides a webhook client secret for signature validation. Store it securely and use it when validating the X-Hub-Signature header.

Receiver Requirements

Your webhook receiver should:

  • Accept POST requests with Content-Type: application/json
  • Validate the X-Hub-Signature header before processing the event
  • Return a 2xx response only after the event is accepted
  • Return a non-2xx response when the event cannot be accepted

Next Steps