Version
WEBHOOK

pass_series.completed

A holder reached the last date of their season, with the final attendance tallies.

When this fires

The last date on one holder's season ticket closed. Their season is over.

Fires per holder, not per series, because "finished" is a fact about a purchase: two people holding the same season reach its end on different dates when one of them bought in late.

This is the renewal signal. The tallies are the half worth acting on. A completion with two of ten attended is a churn signal; the same completion with ten of ten is a renewal one. If the creator linked a next season, the holders-only presale opens around the same moment; see pass_series.presale_opened.

Caveats

  • The subscription is expired at this point, which is normal and not a failure. A dated purchase ends when its dates run out.
  • passes_total is this holder's slate, not the plan's. A mid-season buyer received fewer dates for the same price and their totals reflect that.
  • passes_attended + passes_missed can be less than passes_total when some dates were already covered by passes the holder owned individually; those were not issued twice.
  • successor_plan_id being present does not mean the holder has been invited yet. The presale opens when the series retires, which is a separate event.
  • The plan itself is deactivated automatically once its last date has run for everybody. That arrives as plan.deactivated with reason: series_exhausted.

Related events

  • pass_series.leg_completed: each date along the way, including this one.
  • pass_series.presale_opened: the invitation to the next season.
  • plan.deactivated: the series taking itself off sale.

Ability to subscribe

A token needs this to subscribe an endpoint to the event.

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.

Payload

JSONWhat Subscriby posts to your endpoint

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