Register your webhook endpoint
Register your webhook endpoint to receive notifications when subscription events occur. You'll need to register a separate endpoint for each event type you want to receive.
How to register multiple event types:
If you want to receive multiple event types (e.g., both subscription.created and subscription.updated), make separate registration requests—one for each event type. You can use the same URL for multiple event types if your endpoint handles multiple event types.
What happens after registration: Once registered, Bundled will automatically send POST requests to your endpoint whenever the specified event occurs. We'll use Basic Authentication with the username and password you provide during registration.
Webhook payloads: The payload format depends on which event type you're receiving:
subscription.created: SeeSubscriptionCreatedPayloadschemasubscription.updated: SeeSubscriptionUpdatedPayloadschemasubscription.cancelled: SeeSubscriptionCancelledPayloadschemasubscription.renewed: SeeSubscriptionRenewedPayloadschema
What your endpoint should do:
- Accept POST requests with
Content-Type: application/json - Authenticate requests using Basic Auth (we'll use the credentials you provided)
- Return
200 OKto acknowledge successful receipt - Process the webhook payload to provision or update customer access
Testing your integration: Once registered, use the Simulate a webhook event endpoint to send test events to your webhook URL.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Register your webhook endpoint › Request Body
partnerPartner api_key identifier (e.g., 'dunder_mifflin'). Partner will be created automatically if it doesn't exist.
urlThe URL where you want to receive webhook notifications. This should be a publicly accessible HTTPS endpoint that can accept POST requests.
event_typeThe type of subscription event you want to receive. Choose one event type per registration. To receive multiple event types, register your URL separately for each event type.
Register your webhook endpoint › Responses
Your webhook endpoint has been successfully registered. You'll start receiving webhook events for the specified event type.
endpoint_idA unique identifier for your registered webhook endpoint. Save this ID if you need to update or manage this endpoint later.
partnerYour partner identifier (same as the one you provided in the request)
event_typeThe event type this endpoint is registered to receive
urlThe webhook URL where you'll receive notifications
createdIndicates whether this is a new endpoint registration (true) or an update to an existing endpoint (false)
Simulate a webhook event
Queue a test webhook event with sample data. This uses the same delivery mechanism as production webhooks, so you can test your endpoint with realistic data. The webhook will be sent to your registered endpoint URL via the same cron-based delivery system used in production.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Simulate a webhook event › Request Body
partnerYour partner api_key identifier (e.g., 'dunder_mifflin')
event_typeThe type of webhook event you want to test. You must have a registered endpoint for this event type.
Simulate a webhook event › Responses
Test webhook event queued successfully. The webhook will be sent to your registered endpoint shortly.
messageevent_idUnique identifier for the test event
partnerevent_typepayloadPreview of the payload that will be sent to your endpoint
endpoints_queuedNumber of endpoints that will receive this test event