Pause a Connect configuration

You can pause an active configuration when needed to temporarily halt it from processing events. This can give you more control over event processing, and make it easier to perform updates, maintenance, or troubleshooting without triggering additional activity.

For example, if your Connect configuration is set to include document data with events and your account recently performed a large bulk send, your listener could be put under strain and become overloaded. In this case, you could pause your configuration to give your listener more time to handle the events, or to allocate more resources to it.

You can pause an active configuration in several ways:

• Select the Pause option from the Actions menu under an active configuration on the Connect page.
• Check the Pause Configuration box on the Edit Configuration page.
• Set "pausePublish": "true" in a create or update ConnectConfigurations API call.

When a configuration is unpaused, processing automatically resumes at the next scheduled retry for the affected events.

You can monitor paused events directly in the Connect Dashboard. These events will be clearly marked with the message: This event was skipped due to the configuration being paused.

Pausing does not affect configuration settings, nor reset retry schedules. Any existing retries that are scheduled during the pause window are skipped but not lost. Account-level and organization-level configurations can be paused, but envelope-level configurations are managed separately and cannot be paused. Events that reach the end of their 15-day retry window while paused will expire and must be manually republished after the queue is reactivated.

{
  "connectId": "12345678",
  "configurationType": "custom",
  "urlToPublishTo": "https://webhook.site/cf4ccd66-xxxx-xxxx-xxxx-116fbc153e07",
  "name": "TestAgainOctober",
  "allowEnvelopePublish": "true",
  "deliveryMode": "sim",
  "enableLog": "true",
  "includeDocuments": "false",
  "includeCertificateOfCompletion": "false",
  "requiresAcknowledgement": "true",
  "signMessageWithX509Certificate": "false",
  "useSoapInterface": "false",
  "includeTimeZoneInformation": "false",
  "includeOAuth": "false",
  "includeHMAC": "false",
  "integratorManaged": "false",
  "includeEnvelopeVoidReason": "false",
  "includeSenderAccountasCustomField": "false",
  "events": [
    "envelope-created"],
  "soapNamespace": "",
  "allUsers": "true",
  "allUsersExcept": "false",
  "includeCertSoapHeader": "false",
  "requireMutualTls": "false",
  "includeDocumentFields": "false",
  "pausePublish": "true",
  "eventData": {
    "version": "restv2.1",
    "includeData": []
  },
  "enableOAuthPerConfiguration": "false"
}

Pause configuration FAQ

What happens after I pause the Connect queue?

When you pause the Connect queue, all event processing associated with that configuration will be temporarily halted. This enables you to make updates, perform maintenance, or investigate issues without triggering further event activity.

Here’s what you can expect after pausing the Connect queue:

• Event processing halts. No new events or existing auto retries will be processed while the Connect queue is paused.
• Scheduled retries are skipped. If an event was in a retry cycle when the Connect queue was paused, any retries scheduled during the pause window will be skipped.
• Events are not lost. Skipped events are not discarded; they’re simply bypassed while paused. Once the Connect queue is unpaused, the system will resume retries starting from the next scheduled interval.
• Dashboard visibility. For any skipped events, you’ll see a clear error message in the dashboard: Error – This event was skipped due to the configuration being paused
• No impact on configuration settings. Pausing the Connect queue doesn’t reset your retry schedule or affect your configuration settings. It just suspends activity temporarily.

What could prevent me from pausing a configuration?

The requiresAcknowledgement configuration field must be set to true before any events can be processed**.**

Why am I seeing the error: “This event was skipped due to the configuration being paused”?

This message appears in the dashboard when an event could not be processed because the related configuration was active but paused at the time of execution.

Which types of configurations can be paused?

Account-level and org-level configurations. Envelope-level configurations are managed separately and cannot be paused.

What happens after the Connect queue is unpaused?

When the Connect queue is unpaused, events will resume their normal auto-retry schedule. Any events that were skipped while the Connect queue was paused won’t be retried immediately; instead, they’ll proceed with the next scheduled retry attempt.

Pause example:

The following table shows how events will be processed after a paused configuration is resumed. It shows the status for the initial event and each retry period:

If a configuration is paused during any of the scheduled retries, those retries will be skipped. Processing will resume at the next scheduled retry after the configuration is unpaused.

What is the Connect retry mechanism interval?

If message delivery for a given envelope fails, retries will be attempted using exponential back-off. The retry attempts will be made in the following sequence:

• Five minutes later
• 10 minutes later
• 20 minutes later
• 40 minutes later
• One hour later
• Two hours later
• One day later
• Once per day for a 15-day span

What happens if an event reaches the end of its 15-day retry window while the Connect queue is paused?

If an event exceeds its 15-day auto-retry period while the Connect queue is paused, it will no longer be eligible for automatic retries even after the Connect queue is unpaused. In this case, the event is considered expired from the retry cycle.

To process these events, you’ll need to manually republish them once the Connect queue is active again. This ensures that no event is retried unexpectedly or outside your desired control window.

What happens if I leave my configuration paused?

Paused configurations will be disabled automatically when they are paused for 14 consecutive days.

Next steps

• Learn about the JSON SIM event model
• See how to Implement Connect with your app
• See the Connect FAQ