Version
WEBHOOK

sequence.step_sent

One step of a win-back sequence reached a member.

When this fires

The hourly sweep found the step due and the member's connected account took the message: the creator's text with the placeholders filled for this member, the way back to the project as a button, and the step's coupon code in the text where the creator placed it. The message goes out as an announcement, so the member's channel choices and opt-outs apply. A platform that refuses for the moment (a rate limit, a passing fault, a misconfigured installation) fires nothing and the step stays due for the next hour; one that refuses for good, or a member with no account to reach, fires nothing and ends the passage as sequence.exited with the reason opted_out. After the last step the passage completes quietly: no event marks completion.

Related events

  • sequence.enrolled: the passage this step belongs to.
  • sequence.converted: the member paid again after reading it.
  • coupon.redeemed: the step's coupon used at checkout.

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