capabilities.work

Define Event Type and Subscribe

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

Recipe · 3 steps

Define Event Type and Subscribe

with Convoy · Webhook & Event Subscription Management

Create an event type, an endpoint, and a subscription filtered to that type.

  1. Define a new event type for the project so subscriptions can filter on it.
  2. Register the destination endpoint that will receive events of the new type.
  3. Create a subscription whose filter configuration routes only events of the new type to the endpoint.
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.
  • eventTypeName: The event type name to define (e.g. invoice.created).
  • endpointName: Human-readable name for the new webhook endpoint.
  • endpointUrl: HTTPS URL Convoy will deliver webhooks to.
  • subscriptionName: Name for the subscription filtered to the new event type.
For your developer

Arazzo workflow convoy:define-event-type-and-subscribe, 3 operations: CreateEventType → CreateEndpoint → CreateSubscription. Specs on APIs.io.

More recipes with Convoy

Attach Filter to SubscriptionBatch Retry Failed DeliveriesBroadcast Event and TrackCreate Event and Trace DeliveryFan Out Event to OwnerForce Resend Successful DeliveriesInspect Delivery AttemptsProvision Endpoint and SubscriptionRegister Incoming SourceReplay Event