role.created

A new role is created within a team.

Ability to subscriberole:view

When this fires

Any member of the team (or a token carrying role:create) creates a new role. It also fires three times when a team is first seeded, once for each default role.

Caveats

  • The full ability list is not embedded in this event; fetch the role from the API for complete detail.
  • The three default roles a new team is seeded with (admin, manager, viewer) emit this event too, one per role, at the moment the team is created.

Related events

  • role.updated: subsequent edits.
  • role.deleted: terminal state.

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/role.created

How is this guide?