Version
WEBHOOK

sequence.updated

A win-back sequence changed.

When this fires

A creator renamed the sequence, moved it to another trigger, switched it on or off, or added, rewrote or removed a step on the Revenue Recovery page. Every save fires it, so a consumer always holds the snapshot after the latest write. Switching a sequence off also lets every member part-way through it go, each as sequence.exited with the reason disabled, and enrols nobody new until it runs again.

Caveats

  • Positions move, enrolments do not. A member who was due the removed step receives the step that took its place, and a member past the last remaining step completes on the next sweep. Read the steps by id if you track one.
  • A sequence may hold up to 8 steps. The ninth is refused on the dashboard and fires nothing.

Related events

  • sequence.created: the sequence was built.
  • sequence.exited: the members let go when the sequence was switched off.
  • sequence.deleted: the sequence was deleted.

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