coupon.activated

A coupon was switched on and is being offered at checkout again.

Ability to subscribeproject-coupon:view

When this fires

A creator switched a coupon on through the activate endpoint. Flipping the switch in the dashboard or through the bot does not currently emit this event; those surfaces write through the service layer directly.

This is the availability flip, kept out of coupon.updated on purpose: an automation that cares whether a discount is live wants one event to subscribe to, not a diff of the active key on every save.

Switched on is not the same as redeemable. active: true is one of four conditions. A coupon still will not apply if it is outside its starts_at / expires_at window, if every use is already spoken for, or if the buyer has hit their own per-subscriber cap. Check the window and the caps in the payload before announcing a live sale.

Caveats

  • This is not scheduled. It fires when a person flips the switch. A coupon whose starts_at simply arrived does not emit this; nothing changed on the row. If you need the moment a code becomes redeemable, schedule against starts_at.
  • Re-activating a switched-off coupon does not reset its counts. Redemptions taken before it was switched off still count against max_redemptions, so a code that was exhausted before is still exhausted after.
  • Idempotent flips still emit. Activating an already-active coupon over the API emits this again. De-dup on the event id.

Related events

  • coupon.deactivated: the paired transition.
  • coupon.updated: a terms change, which deliberately excludes this flip.

Header Parameters

SB-Signature*string

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=.

SB-Event-Id*string

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.

SB-Event-Name*string

The event name, the same as the envelope's type.

Content-Type*string

Always application/json.

User-Agent*string

Always Subscriby-Webhooks/1.0.

Request Body

application/json

The signed JSON envelope posted to your endpoint.

TypeScript Definitions

Use the request body type in TypeScript.

The envelope every event is delivered in.

Response Body

Example Requests

POST/coupon.activated

How is this guide?