capabilities.work

Attach Filter to Subscription

A 3-step recipe with Convoy. We can help you get access.

Recipe · 3 steps

Attach Filter to Subscription

with Convoy · Webhook & Event Subscription Management

Create a subscription, add an event-type filter, and list its filters.

  1. Create a subscription bound to the supplied endpoint.
  2. Attach a filter matching the supplied event type with optional body criteria to the subscription.
  3. List the filters on the subscription to confirm the new filter was stored.
What you'll need to have ready
  • apiKey: Convoy API key used as the Bearer token on the Authorization header.
  • projectID: The Convoy project identifier.
  • endpointId: Existing destination endpoint the subscription routes events to.
  • subscriptionName: Name for the new subscription.
  • eventType: Event type the filter applies to (e.g. invoice.paid).
  • filterBody: Optional body matching criteria for the filter.
For your developer

Arazzo workflow convoy:attach-filter-to-subscription, 3 operations: CreateSubscription → CreateFilter → GetFilters. Specs on APIs.io.