capabilities.work

Provision Endpoint and Subscription

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

Recipe · 4 steps

Provision Endpoint and Subscription

with Convoy · Webhook & Event Subscription Management

Create an endpoint, subscribe it, publish an event, and verify delivery.

  1. Register a new outgoing webhook endpoint in the project with the supplied name and HTTPS URL.
  2. Create an API subscription that forwards matching events to the newly created endpoint.
  3. Publish a first event addressed to the new endpoint so the subscription can route it.
  4. List the event deliveries generated for the endpoint to confirm the event was dispatched.
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 the endpoint belongs to.
  • endpointName: Human-readable name for the new webhook endpoint.
  • endpointUrl: HTTPS URL Convoy will deliver webhooks to.
  • subscriptionName: Name for the subscription that routes events to the endpoint.
  • eventType: Event type used for filtering and debugging (e.g. invoice.paid).
  • eventData: Arbitrary JSON payload sent as the webhook body.
For your developer

Arazzo workflow convoy:provision-endpoint-subscription, 4 operations: CreateEndpoint → CreateSubscription → CreateEndpointEvent → GetEventDeliveriesPaged. Specs on APIs.io.

More recipes with Convoy

Attach Filter to SubscriptionBatch Retry Failed DeliveriesBroadcast Event and TrackCreate Event and Trace DeliveryDefine Event Type and SubscribeFan Out Event to OwnerForce Resend Successful DeliveriesInspect Delivery AttemptsRegister Incoming SourceReplay Event