access_code.expired
A code passes its expiry without redemption.
When this fires
An access code passes its expiry without being redeemed. The placeholder subscription row holding it is hard-deleted immediately after this event is emitted.
The code string itself is not included on this event; only access_code.redeemed carries access_code. The placeholder row referenced by subscription_id is hard-deleted immediately after this event is emitted, so it will not resolve through the API.
Caveats
- Expiry is detected by a sweep that runs every five minutes, so
created_attrailsexpired_atby up to five minutes plus queue latency. - Large batches may produce a sustained burst of
access_code.expiredevents when the batch hits its expiry. Plan capacity accordingly. - Codes that were already redeemed do not produce this event regardless of the batch's
expires_at.
Related events
access_code.redeemed: alternative outcome.access_code.generated: predecessor (batch-level).
Ability to subscribe
A token needs this to subscribe an endpoint to the event.
Header Parameters
t=<unix seconds>,v1=<hex>: the HMAC-SHA256 of "<t>.<raw body>" under the endpoint's secret. Verify it before acting, and refuse a t more than 300 seconds from now. During a secret rotation a v0= signature under the previous secret may precede v1=.
The event's ULID, bare. The envelope's id is the same ULID prefixed evt_, so strip the prefix before comparing. Deduplicate on it: a retry carries the same id.
The event name, the same as the envelope's type.
Always application/json.
Always Subscriby-Webhooks/1.0.
Payload
JSONWhat Subscriby posts to your endpointapplication/json
The signed JSON envelope posted to your endpoint.
The envelope every event is delivered in.
Responses
2XXAny success status
Your endpoint acknowledged the delivery. Any 2xx status within 30 seconds marks it delivered; the response body is ignored.
defaultAny other status
Any other status, a connection failure, or no answer within 30 seconds counts as a failed attempt. The delivery is retried 8 times, after 10 seconds, 30 seconds, 2 minutes, 10 minutes, 1 hour, 6 hours, 1 day, 3 days; the last failure dead-letters it, and it can be retried from the dashboard or POST /v1/webhook-deliveries/{delivery}/retry. After 20 consecutive failures the endpoint is paused until it is resumed.
How is this guide?
Last updated on