Skip to main content

Setting Up Webhooks

Learn how to create, secure, test, and monitor a webhook endpoint for Content View events in Archive.

Written by Luiza Diniz

📋 Available on: Workspaces with Archive API access.

Webhooks let Archive send signed POST requests to your endpoint when new content matches a Content View. This gives your system a push-based alternative to checking the API on a timer.


Creating a Webhook Endpoint

  1. Open Settings → Webhooks in your Archive workspace.

  2. Click New endpoint.

  3. Enter a descriptive Name for the receiving system.

  4. Enter its public HTTPS address in Endpoint URL. The URL must use HTTPS, use port 443 or a port numbered 1024 or higher, contain no credentials, and respond without a redirect.

  5. Under Events, select Item added to view.

  6. Under Content views, select the views this endpoint should watch. Each selected view's filters determine which new items trigger an event.

  7. Click Create endpoint.

🚨 Save the signing secret immediately. Archive displays the full secret only once. Keep the whsec_ prefix — it is part of the key used to verify each delivery's X-Archive-Signature header.

If You Lose the Signing Secret

You can replace it. Open the endpoint, then choose ⋯ → Rotate secret…. Archive shows the new secret once, so save it right away.

For 24 hours after a rotation, Archive signs each delivery with both the new and the previous secret, so a receiver still using the old one keeps validating. After that, only the new secret works. The 24 hours run from the rotation itself, not from the next delivery.

Managing an Endpoint

The ⋯ menu on the endpoint holds the rest of its actions:

  • Edit endpoint — change the name, the URL, or which Content views it watches.

  • Rotate secret… — replace the signing secret, as above.

  • Delete endpoint… — deliveries stop immediately and the delivery history is removed with it. Events stay in the shared event log.

Pause sits next to Send test event and stops deliveries without deleting anything. Use it while the receiving system is down.


Testing the Endpoint

Open the endpoint and click Send test event. Archive shows whether the test was delivered successfully. If it fails, confirm that the endpoint is publicly reachable over HTTPS and accepts POST requests.

Test succeed:

Test failed:

Use the signing secret to verify the X-Archive-Signature header before processing a delivery. See the API documentation for the delivery payload and verification details.


When Events Fire

The supported event is content_view.item_added, shown in Archive as Item added to view. Archive schedules its first Content View match check about five minutes after a new item reaches the workspace.

An item can trigger one event for each selected Content View it matches. The same item does not fire again for the same Content View after that first match.


Monitoring Deliveries

Open an endpoint to review its Deliveries and Events tabs. Delivery history shows succeeded, failed, dropped, and pending deliveries. Event history is the reconciliation record for events that matched.

Archive retains webhook delivery and event history for 30 days. Failed deliveries can be attempted up to eight times. When a failed delivery has exhausted its retries, use the endpoint's activity log to investigate and redeliver it after the receiving system is healthy.


Common Questions

  • Can I subscribe to engagement changes?

    There is no separate engagement-changed event. The subscribable event is Item added to view, so use a Content View to define the content your endpoint should receive.

  • Can one item generate more than one event?

    Yes. If an item matches two watched Content Views, it can generate one event for each view. It will not fire again for the same item-and-view pair.

  • What if I lose the signing secret?

    Open the endpoint and choose Rotate secret…. Save the new secret immediately; Archive displays it only once.

  • Where can I check a missing delivery?

    Open the endpoint and review Deliveries first, then Events. Deliveries show what Archive attempted to send; Events show what matched and can be used to reconcile a missed delivery.

Did this answer your question?