Pause and Resume Connections

Pausing a Connection is a feature for managing your event-driven workflows, especially during maintenance, deployments, or when dealing with unreliable endpoints. This guide explains how to pause and resume your Connections and what happens to your Events during the process.

This is useful in many scenarios:

• Pausing inbound webhooks during unexpected downtime of your ingestion workers.
• Pausing outbound webhooks if a customer's webhook endpoint is experiencing problems.
• Pausing inbound Async API requests if an API handler is having problems.
• Pausing requests to third-party APIs if you need to make changes to your API requests.

Hookdeck's Pause/Resume Feature

The pause and resume functionality operates at the Connection level. When a Connection is paused, the Hookdeck Event Gateway continues to accept Events from the Source , but it queues them instead of attempting delivery to the Destination . This ensures that no data is lost while the Connection is inactive.

How to Pause a Connection

You can pause a Connection directly from the Hookdeck dashboard.

1. Navigate to the Connections page in your Project .
2. Locate the Connection you wish to pause.
3. Click the Pause button and confirm your action.

Once paused, the Connection's status will be updated with a "Paused" indicator, providing a clear visual confirmation.

Behavior of Paused Connections

When a Connection is paused:

• Event Ingestion: Hookdeck continues to ingest and store all incoming Events from the Source .
• Delivery Attempts: No delivery Attempts are made to the Destination . This prevents errors and retries that would otherwise occur if the endpoint is down.
• Event Queuing: Events accumulate in the queue for that specific Connection. Hookdeck is designed to handle large volumes of queued Events, but it's important to be aware of your data retention policies for long pauses.

How to Resume a Connection

Resuming a Connection is as straightforward as pausing it.

1. Navigate to the Connections page.
2. Find the paused Connection.
3. Click Unpause button and confirm your action.

Once you resume the Connection, Hookdeck will begin processing the queued Events . Delivery will proceed, respecting any rate limit settings configured for the Destination .

Monitoring During Pause/Resume

It's important to monitor your Connections after pausing or resuming them.

• Queue Length: From the Connections page, you can observe the number of Events queued for any paused Connection. This helps you understand the volume of data waiting to be processed.
• Event Delivery: After resuming, you can monitor the flow of Events and view the status of delivery Attempts on the Events page to ensure everything is working as expected.

Related Hookdeck Features & Documentation

To learn more about the concepts discussed in this guide, refer to the following documentation:

Connections Documentation ->

Detailed information on managing your connections.