Skip to main content

How do they work?

Get to know how you can start using the Subscriber to Events feature

Create a Subscription​

To create a Subscription:

Create new Subscription

  1. Be sure to be inside the newly created Topic or Source. If you need more information about Topics or Sources, please review the Quick Quide
  2. Press the Add Subscription button.
  3. Give the Subscription a unique name.
  4. Add a description for the Subscription.
  5. Choose the events that the Subscription wants to subscribe to. This step is only applicable when Publishing events to a Topic.
  6. If applicable, you can choose to apply advanced filtering, aggregation and transformation to incoming events.
  7. Set a webhook endpoint URL.
  8. Configure the maximum retries for the webhook.
  9. Press the Create button.
  10. Once the Subscription has been created, you can view the Subscription Webhook Secret.

It’s really that simple! Your subscription is now configured and will begin delivering the events you’ve selected or refined with Advanced Querying. In the next sections, we’ll explore more about Advanced Querying, retries, dead lettering, and webhook signing.

Update a Subscription​

To edit a Subscription:

Edit Subscription

  1. Be sure to be inside an existing Topic or Source.
  2. Press the cog button.
  3. Update the Subscription name (must be a unique name).
  4. Edit the description for the Subscription.
  5. Update the events that the Subscription wants to subscribe to. This step is only applicable when Publishing events to a Topic.
  6. If applicable, you can choose to apply advanced filtering, aggregation and transformation to incoming events.
  7. Amend the webhook endpoint URL.
  8. Configure the maximum retries for the webhook.
  9. Press the update button.
  10. Once the Subscription has been edited, you can view the Subscription Webhook Secret.

Delete a Subscription​

To Delete a Subscription:

Delete Subscription

  1. Be sure to be inside an existing Topic or Source.
  2. Press the cog button.
  3. Scroll to the bottom of the Subscription to the Danger Zone
  4. Press Delete Subscription
  5. To avoid accidentally deleting a Subscription, you will need to reaffirm the action before the Subscription is successfully deleted. If you're happy to delete, just press the tick icon.
danger

Deleting a Subscription is permanent and cannot be undone. Ensure you no longer need the Subscription before proceeding.

This action can have a significant impact on any systems subscribed to the Subscription.