Skip to content
PayloadPuffin.
Join the waitlist

Rotate a source URL

To replace a source URL without missing webhooks, rotate its token and choose a grace period. The old URL keeps working during that period, so you can give the sending service the new URL before the old one stops. The source keeps its ID, name, event type and channels.

You need the owner or admin role in your organization, or an API key with sources:write.

Rotate the URL

  1. Open Sources and select the source.
  2. In the URL section, click Rotate URL.
  3. In Stop the old URL, choose how long the old URL keeps working: immediately, or in 1 hour up to in 7 days.
  4. Click Rotate URL.
  5. Copy the new URL from the dialog. It's shown only once.

The panel then says until when the previous URL works. With the API, Rotate a source token takes the same choice as expiry and returns the new URL as secretUrl.

The new URL can take up to a minute to work everywhere.

Stop the old URL

The old URL stops on its own when the grace period ends. To stop it sooner, click Stop the previous URL next to that note and confirm with Stop previous URL, or call Expire the previous source token. Requests to the old URL then get 404, within a minute.

Limits

  • A source has at most two working URLs. While the previous URL still works, rotating is refused with 409. Stop the previous URL or wait for it to expire first.
  • Rotating a deleted source answers 404, as for a source that never existed.
  • If a URL has leaked, rotate with immediately, or delete the source. Deleting stops both URLs.