team.member.invited

An invitation is issued to a new collaborator.

Ability to subscribeteam:view

When this fires

A team owner or manager invites a collaborator by email. The collaborator becomes a member only once they accept and team.member.joined fires. The invitee has not yet accepted at this point.

Caveats

  • An invitation can be revoked without producing a follow-up event in this family. Invitations do not expire: a pending one stands until it is accepted or withdrawn.
  • The collaborator does not have access until they accept; expect team.member.joined.

Related events

  • team.member.joined: fires on acceptance.
  • team.member.removed: fires only if the collaborator accepts and is later removed. Withdrawing the invitation itself emits nothing.

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/team.member.invited

How is this guide?