Get started
Webhooks

organization.invitation

organization.invitation

Subscribe an endpoint to every event on this page with organization.invitation.*. Each is the envelope every webhook event shares, with the OrganizationInvitationEventObject object as its data.object.

Event typeWhat happened
organization.invitation.createdSomebody was invited to an organization.
organization.invitation.acceptedAn invitation was accepted.
organization.invitation.declinedAn invitation was declined.
organization.invitation.revokedAn invitation was withdrawn.
organization.invitation.expiredAn invitation lapsed unanswered.
organization.invitation.deletedAn invitation was superseded.

The OrganizationInvitationEventObject object

An invitation as a webhook event carries it: the address it names, the role it grants, who made it and when it lapses. It is the invitation as it stood when the change was made, so the one an organization.invitation.accepted carries is consumed by then.

object

string

required

One of: organization.invitation

The kind of object this is, always organization.invitation: the family of the event types that carry it, and what tells the members of WebhookEventObject apart.

id

string (uuid)

required

Identifier of the invitation.

email

string (email)

required

The address invited, trimmed and lowercased.

role

string

required

One of: admin, contributor, viewer

The role the person holds once they accept.

invited_by

object

required

The member who made the invitation.

created_at

string (date-time)

required

When the invitation was made.

expires_at

string (date-time)

required

When the invitation lapses unanswered, thirty days after it was made.

organization.invitation.created

An invitation was made.

Triggered by

  • organization.invitation.create: Always.
    • POST /v1/organizations/{organization_id}/invitations: postOrganizationInvitation, mountaya.admin.invitations.postOrganizationInvitation() in TypeScript. Every invitation made.
    • Mountaya's web application: An invitation made signed in to Mountaya's web application.

Payload

type

string

required

One of: organization.invitation.created

Always organization.invitation.created.

data.object

OrganizationInvitationEventObject

required

The organization invitation.

See the OrganizationInvitationEventObject object.

Every other field is the envelope every webhook event shares.

organization.invitation.accepted

The person invited accepted the invitation, and is a member from then on.

Triggered by

  • organization.invitation.accept: Always.
    • POST /v1/me/invitations/{invitation_id}/accept: postMyInvitationAccept, mountaya.admin.users.postMyInvitationAccept() in TypeScript. Every invitation accepted.
    • Mountaya's web application: An invitation accepted signed in to Mountaya's web application.

Payload

type

string

required

One of: organization.invitation.accepted

Always organization.invitation.accepted.

data.object

OrganizationInvitationEventObject

required

The organization invitation.

See the OrganizationInvitationEventObject object.

Every other field is the envelope every webhook event shares.

organization.invitation.declined

The person invited declined the invitation.

Triggered by

  • organization.invitation.decline: When the invitation was waiting for the person.
    • DELETE /v1/me/invitations/{invitation_id}: deleteMyInvitation, mountaya.admin.users.deleteMyInvitation() in TypeScript. Every request.
    • Mountaya's web application: An invitation declined signed in to Mountaya's web application.

Payload

type

string

required

One of: organization.invitation.declined

Always organization.invitation.declined.

data.object

OrganizationInvitationEventObject

required

The organization invitation.

See the OrganizationInvitationEventObject object.

Every other field is the envelope every webhook event shares.

organization.invitation.revoked

A member withdrew an invitation still waiting for an answer.

Triggered by

  • organization.invitation.revoke: When the invitation was waiting for an answer.
    • DELETE /v1/organizations/{organization_id}/invitations/{invitation_id}: deleteOrganizationInvitation, mountaya.admin.invitations.deleteOrganizationInvitation() in TypeScript. Every request.
    • Mountaya's web application: An invitation withdrawn signed in to Mountaya's web application.

Payload

type

string

required

One of: organization.invitation.revoked

Always organization.invitation.revoked.

data.object

OrganizationInvitationEventObject

required

The organization invitation.

See the OrganizationInvitationEventObject object.

Every other field is the envelope every webhook event shares.

organization.invitation.expired

An invitation lapsed unanswered thirty days after it was made, and was cleared away.

Triggered by

  • organization.invitation.create: Once for each invitation of the organization that had lapsed unanswered, cleared before the new one is counted against the seats.
    • POST /v1/organizations/{organization_id}/invitations: postOrganizationInvitation, mountaya.admin.invitations.postOrganizationInvitation() in TypeScript. Every invitation made.
    • Mountaya's web application: An invitation made signed in to Mountaya's web application.
  • organization.invitation.revoke: When the invitation had lapsed unanswered and had not been cleared yet.
    • DELETE /v1/organizations/{organization_id}/invitations/{invitation_id}: deleteOrganizationInvitation, mountaya.admin.invitations.deleteOrganizationInvitation() in TypeScript. Every request.
    • Mountaya's web application: An invitation withdrawn signed in to Mountaya's web application.
  • organization.invitation.expire: Once for each invitation that lapsed since the last run.
    • A schedule: Every hour.

Payload

type

string

required

One of: organization.invitation.expired

Always organization.invitation.expired.

data.object

OrganizationInvitationEventObject

required

The organization invitation.

See the OrganizationInvitationEventObject object.

Every other field is the envelope every webhook event shares.

organization.invitation.deleted

An invitation was cleared because the person it names joined the organization through another invitation.

Triggered by

  • organization.invitation.accept: Once for each other invitation of the person to the same organization, which joining supersedes.
    • POST /v1/me/invitations/{invitation_id}/accept: postMyInvitationAccept, mountaya.admin.users.postMyInvitationAccept() in TypeScript. Every invitation accepted.
    • Mountaya's web application: An invitation accepted signed in to Mountaya's web application.

Payload

type

string

required

One of: organization.invitation.deleted

Always organization.invitation.deleted.

data.object

OrganizationInvitationEventObject

required

The organization invitation.

See the OrganizationInvitationEventObject object.

Every other field is the envelope every webhook event shares.