User events

This page documents the webhook events related to user operations in Scalekit.

User authentication events

`user.signup`

This webhook is triggered when a user signs up to create a new organization. The event type is user.signup

1
{
2
  "environment_id": "env_1234567890",
3
  "id": "evt_1234567890",
4
  "object": "OrgMembershipEvent",
5
  "occurred_at": "2024-01-15T10:30:00.123456789Z",
6
  "spec_version": "1",
7
  "type": "user.signup",
8
  "data": {
9
    "organization": {
10
      "id": "org_1234567890"
11
    },
12
    "user": {
13
      "create_time": "2024-01-15T10:30:00Z",
14
      "email": "user@example.com",
15
      "id": "usr_1234567890",
16
      "membership": {
17
        "accepted_at": "2024-01-15T10:30:00Z",
18
        "created_at": "2024-01-15T10:30:00Z",
19
        "membership_status": "ACTIVE",
20
        "organization_id": "org_1234567890",
21
        "provisioning_method": "org_creator",
22
        "roles": [
23
          {
24
            "id": "role_1234567890"
25
          }
26
        ]
27
      },
28
      "update_time": "2024-01-15T10:30:00Z",
29
      "user_profile": {
30
        "email_verified": true,
31
        "id": "usp_1234567890"
32
      }
33
    }
34
  }
35
}

Field	Type	Description
`organization`	object	Organization details associated with the signup
`organization.id`	string	Unique identifier for the organization
`user`	object	User details for the signed-up user
`user.id`	string	Unique identifier for the user
`user.email`	string	Email address of the user
`user.create_time`	string	Timestamp of when the user was created
`user.update_time`	string	Timestamp of when the user was last updated
`user.user_profile`	object	User profile information
`user.user_profile.id`	string	Unique identifier for the user profile
`user.user_profile.email_verified`	boolean	Indicates if the user’s email is verified
`user.membership`	object	Organization membership details
`user.membership.organization_id`	string	Identifier for the organization
`user.membership.membership_status`	string	Status of the membership (ACTIVE, PENDING, etc.)
`user.membership.provisioning_method`	string	Method used for provisioning (org_creator, JIT, etc.)
`user.membership.created_at`	string	Timestamp of when the membership was created
`user.membership.accepted_at`	string	Timestamp of when the membership was accepted
`user.membership.roles`	array	Array of roles assigned to the user

`user.login`

This webhook is triggered when a user logs in and a session is created. The event type is user.login

1
{
2
  "environment_id": "env_1234567890",
3
  "id": "evt_2345678901",
4
  "object": "UserLoginEvent",
5
  "occurred_at": "2024-01-15T10:35:00.123456789Z",
6
  "spec_version": "1",
7
  "type": "user.login",
8
  "data": {
9
    "user": {
10
      "create_time": "2024-01-15T10:30:00Z",
11
      "email": "user@example.com",
12
      "id": "usr_1234567890",
13
      "membership": {
14
        "accepted_at": "2024-01-15T10:30:00Z",
15
        "created_at": "2024-01-15T10:30:00Z",
16
        "display_name": "Acme Corporation",
17
        "membership_status": "ACTIVE",
18
        "name": "Acme Corporation",
19
        "organization_id": "org_1234567890",
20
        "provisioning_method": "org_creator",
21
        "roles": [
22
          {
23
            "id": "role_1234567890"
24
          }
25
        ]
26
      },
27
      "update_time": "2024-01-15T10:30:00Z",
28
      "user_profile": {
29
        "email_verified": true,
30
        "family_name": "Doe",
31
        "given_name": "John",
32
        "id": "usp_1234567890",
33
        "name": "John Doe"
34
      }
35
    }
36
  }
37
}

Field	Type	Description
`user`	object	User details for the logged-in user
`user.id`	string	Unique identifier for the user
`user.email`	string	Email address of the user
`user.create_time`	string	Timestamp of when the user was created
`user.update_time`	string	Timestamp of when the user was last updated
`user.user_profile`	object	User profile information
`user.user_profile.id`	string	Unique identifier for the user profile
`user.user_profile.name`	string	Full name of the user
`user.user_profile.given_name`	string	Given name of the user
`user.user_profile.family_name`	string	Family name of the user
`user.user_profile.email_verified`	boolean	Indicates if the user’s email is verified
`user.membership`	object	Organization membership details
`user.membership.organization_id`	string	Identifier for the organization
`user.membership.name`	string	Name of the organization
`user.membership.display_name`	string	Display name for the organization
`user.membership.membership_status`	string	Status of the membership (ACTIVE, PENDING, etc.)
`user.membership.provisioning_method`	string	Method used for provisioning (org_creator, JIT, etc.)
`user.membership.created_at`	string	Timestamp of when the membership was created
`user.membership.accepted_at`	string	Timestamp of when the membership was accepted
`user.membership.roles`	array	Array of roles assigned to the user

`user.logout`

This webhook is triggered when a user logs out and the session is terminated. The event type is user.logout

1
{
2
  "environment_id": "env_1234567890",
3
  "id": "evt_3456789012",
4
  "object": "UserLogoutEvent",
5
  "occurred_at": "2024-01-15T10:40:00.123456789Z",
6
  "spec_version": "1",
7
  "type": "user.logout",
8
  "data": {
9
    "user": {
10
      "create_time": "2024-01-15T10:30:00Z",
11
      "email": "user@example.com",
12
      "external_id": "user_ext_123",
13
      "id": "usr_1234567890",
14
      "membership": {
15
        "accepted_at": "2024-01-15T10:30:00Z",
16
        "created_at": "2024-01-15T10:30:00Z",
17
        "display_name": "Acme Corporation",
18
        "membership_status": "ACTIVE",
19
        "name": "Acme Corporation",
20
        "organization_id": "org_1234567890",
21
        "provisioning_method": "org_creator",
22
        "roles": [
23
          {
24
            "id": "role_1234567890"
25
          }
26
        ]
27
      },
28
      "update_time": "2024-01-15T10:35:00Z",
29
      "user_profile": {
30
        "email_verified": true,
31
        "family_name": "Doe",
32
        "given_name": "John",
33
        "id": "usp_1234567890",
34
        "name": "John Doe"
35
      }
36
    }
37
  }
38
}

Field	Type	Description
`user`	object	User details for the logged-out user
`user.id`	string	Unique identifier for the user
`user.email`	string	Email address of the user
`user.external_id`	string	External identifier for the user
`user.create_time`	string	Timestamp of when the user was created
`user.update_time`	string	Timestamp of when the user was last updated
`user.user_profile`	object	User profile information
`user.user_profile.id`	string	Unique identifier for the user profile
`user.user_profile.name`	string	Full name of the user
`user.user_profile.given_name`	string	Given name of the user
`user.user_profile.family_name`	string	Family name of the user
`user.user_profile.email_verified`	boolean	Indicates if the user’s email is verified
`user.membership`	object	Organization membership details
`user.membership.organization_id`	string	Identifier for the organization
`user.membership.name`	string	Name of the organization
`user.membership.display_name`	string	Display name for the organization
`user.membership.membership_status`	string	Status of the membership (ACTIVE, PENDING, etc.)
`user.membership.provisioning_method`	string	Method used for provisioning (org_creator, JIT, etc.)
`user.membership.created_at`	string	Timestamp of when the membership was created
`user.membership.accepted_at`	string	Timestamp of when the membership was accepted
`user.membership.roles`	array	Array of roles assigned to the user

Organization membership events

`user.organization_invitation`

This webhook is triggered when a user is invited to join an organization. The event type is user.organization_invitation

1
{
2
  "environment_id": "env_1234567890",
3
  "id": "evt_4567890123",
4
  "object": "OrgMembershipEvent",
5
  "occurred_at": "2024-01-15T11:00:00.123456789Z",
6
  "spec_version": "1",
7
  "type": "user.organization_invitation",
8
  "data": {
9
    "organization": {
10
      "external_id": "org_external_456",
11
      "id": "org_2345678901"
12
    },
13
    "user": {
14
      "create_time": "2024-01-15T11:00:00Z",
15
      "email": "newuser@example.com",
16
      "id": "usr_2345678901",
17
      "membership": {
18
        "created_at": "2024-01-15T11:00:00Z",
19
        "display_name": "Example Corp",
20
        "membership_status": "PENDING_INVITE",
21
        "name": "Example Corp",
22
        "organization_id": "org_2345678901",
23
        "provisioning_method": "invitation",
24
        "roles": [
25
          {
26
            "id": "role_2345678901"
27
          }
28
        ]
29
      },
30
      "update_time": "2024-01-15T11:00:00Z",
31
      "user_profile": {
32
        "id": "usp_2345678901"
33
      }
34
    }
35
  }
36
}

Field	Type	Description
`organization`	object	Organization details for the invitation
`organization.id`	string	Unique identifier for the organization
`organization.external_id`	string	External identifier for the organization
`user`	object	User details for the invited user
`user.id`	string	Unique identifier for the user
`user.email`	string	Email address of the user
`user.create_time`	string	Timestamp of when the user was created
`user.update_time`	string	Timestamp of when the user was last updated
`user.user_profile`	object	User profile information
`user.user_profile.id`	string	Unique identifier for the user profile
`user.membership`	object	Organization membership details
`user.membership.organization_id`	string	Identifier for the organization
`user.membership.name`	string	Name of the organization
`user.membership.display_name`	string	Display name for the organization membership
`user.membership.membership_status`	string	Status of the membership (PENDING_INVITE for invitations)
`user.membership.provisioning_method`	string	Method used for provisioning (invitation in this case)
`user.membership.created_at`	string	Timestamp of when the membership invitation was created
`user.membership.roles`	array	Array of roles that will be assigned to the user upon acceptance

`user.organization_membership_created`

This webhook is triggered when a user joins an organization. The event type is user.organization_membership_created

1
{
2
  "environment_id": "env_1234567890",
3
  "id": "evt_5678901234",
4
  "object": "OrgMembershipEvent",
5
  "occurred_at": "2024-01-15T11:05:00.123456789Z",
6
  "spec_version": "1",
7
  "type": "user.organization_membership_created",
8
  "data": {
9
    "organization": {
10
      "external_id": "org_external_456",
11
      "id": "org_2345678901"
12
    },
13
    "user": {
14
      "create_time": "2024-01-15T11:00:00Z",
15
      "email": "newuser@example.com",
16
      "id": "usr_2345678901",
17
      "membership": {
18
        "accepted_at": "2024-01-15T11:05:00Z",
19
        "created_at": "2024-01-15T11:00:00Z",
20
        "display_name": "Example Corp",
21
        "membership_status": "ACTIVE",
22
        "name": "Example Corp",
23
        "organization_id": "org_2345678901",
24
        "provisioning_method": "invitation",
25
        "roles": [
26
          {
27
            "id": "role_2345678901"
28
          }
29
        ]
30
      },
31
      "update_time": "2024-01-15T11:00:00Z",
32
      "user_profile": {
33
        "email_verified": true,
34
        "id": "usp_2345678901"
35
      }
36
    }
37
  }
38
}

Field	Type	Description
`organization`	object	Organization details
`organization.id`	string	Unique identifier for the organization
`organization.external_id`	string	External identifier for the organization
`user`	object	User details
`user.id`	string	Unique identifier for the user
`user.email`	string	Email address of the user
`user.create_time`	string	Timestamp of when the user was created
`user.update_time`	string	Timestamp of when the user was last updated
`user.user_profile`	object	User profile information
`user.user_profile.id`	string	Unique identifier for the user profile
`user.user_profile.email_verified`	boolean	Indicates if the user’s email is verified
`user.membership`	object	Organization membership details
`user.membership.organization_id`	string	Identifier for the organization
`user.membership.name`	string	Name of the organization
`user.membership.display_name`	string	Display name for the organization
`user.membership.membership_status`	string	Status of the membership (ACTIVE, PENDING, etc.)
`user.membership.provisioning_method`	string	Method used for provisioning (org_creator, JIT, etc.)
`user.membership.created_at`	string	Timestamp of when the membership was created
`user.membership.accepted_at`	string	Timestamp of when the membership was accepted
`user.membership.roles`	array	Array of roles assigned to the user

`user.organization_membership_updated`

This webhook is triggered when a user’s organization membership is updated, e.g., change of user’s role in an organization.The event type is user.organization_membership_updated

1
{
2
  "environment_id": "env_1234567890",
3
  "id": "evt_6789012345",
4
  "object": "OrgMembershipEvent",
5
  "occurred_at": "2024-01-15T11:10:00.123456789Z",
6
  "spec_version": "1",
7
  "type": "user.organization_membership_updated",
8
  "data": {
9
    "organization": {
10
      "external_id": "org_external_456",
11
      "id": "org_2345678901"
12
    },
13
    "user": {
14
      "create_time": "2024-01-15T11:00:00Z",
15
      "email": "newuser@example.com",
16
      "environment_id": "env_1234567890",
17
      "external_id": "user_ext_456",
18
      "id": "usr_2345678901",
19
      "membership": {
20
        "accepted_at": "2024-01-15T11:10:00Z",
21
        "created_at": "2024-01-15T11:00:00Z",
22
        "display_name": "Example Corp",
23
        "membership_status": "ACTIVE",
24
        "name": "Example Corp",
25
        "organization_id": "org_2345678901",
26
        "provisioning_method": "invitation",
27
        "roles": [
28
          {
29
            "id": "role_3456789012"
30
          }
31
        ]
32
      },
33
      "update_time": "2024-01-15T11:05:00Z",
34
      "user_profile": {
35
        "email_verified": true,
36
        "id": "usp_2345678901"
37
      }
38
    }
39
  }
40
}

Field	Type	Description
`organization`	object	Organization details
`organization.id`	string	Unique identifier for the organization
`organization.external_id`	string	External identifier for the organization
`user`	object	User details
`user.id`	string	Unique identifier for the user
`user.email`	string	Email address of the user
`user.external_id`	string	External identifier for the user
`user.environment_id`	string	Identifier for the environment
`user.create_time`	string	Timestamp of when the user was created
`user.update_time`	string	Timestamp of when the user was last updated
`user.user_profile`	object	User profile information
`user.user_profile.id`	string	Unique identifier for the user profile
`user.user_profile.email_verified`	boolean	Indicates if the user’s email is verified
`user.membership`	object	Organization membership details
`user.membership.organization_id`	string	Identifier for the organization
`user.membership.name`	string	Name of the organization
`user.membership.display_name`	string	Display name for the organization membership
`user.membership.membership_status`	string	Status of the membership (ACTIVE, PENDING, etc.)
`user.membership.provisioning_method`	string	Method used for provisioning (JIT, org_creator, etc.)
`user.membership.created_at`	string	Timestamp of when the membership was created
`user.membership.accepted_at`	string	Timestamp of when the membership was accepted
`user.membership.roles`	array	Array of roles assigned to the user

`user.organization_membership_deleted`

This webhook is triggered when a user is removed from an organization. The event type is user.organization_membership_deleted

1
{
2
  "environment_id": "env_1234567890",
3
  "id": "evt_7890123456",
4
  "object": "OrgMembershipEvent",
5
  "occurred_at": "2024-01-15T11:15:00.123456789Z",
6
  "spec_version": "1",
7
  "type": "user.organization_membership_deleted",
8
  "data": {
9
    "organization": {
10
      "external_id": "org_external_456",
11
      "id": "org_2345678901"
12
    },
13
    "user": {
14
      "create_time": "2024-01-15T11:00:00Z",
15
      "email": "newuser@example.com",
16
      "external_id": "user_ext_456",
17
      "id": "usr_2345678901",
18
      "membership": {
19
        "created_at": "2024-01-15T11:00:00Z",
20
        "display_name": "Example Corp",
21
        "membership_status": "DELETED",
22
        "organization_id": "org_2345678901",
23
        "provisioning_method": "invitation",
24
        "roles": [
25
          {
26
            "id": "role_3456789012"
27
          }
28
        ]
29
      },
30
      "update_time": "2024-01-15T11:05:00Z",
31
      "user_profile": {
32
        "email_verified": true,
33
        "id": "usp_2345678901"
34
      }
35
    }
36
  }
37
}

Field	Type	Description
`organization`	object	Organization details
`organization.id`	string	Unique identifier for the organization
`organization.external_id`	string	External identifier for the organization
`user`	object	User details
`user.id`	string	Unique identifier for the user
`user.email`	string	Email address of the user
`user.external_id`	string	External identifier for the user
`user.create_time`	string	Timestamp of when the user was created
`user.update_time`	string	Timestamp of when the user was last updated
`user.user_profile`	object	User profile information
`user.user_profile.id`	string	Unique identifier for the user profile
`user.user_profile.email_verified`	boolean	Indicates if the user’s email is verified
`user.membership`	object	Organization membership details
`user.membership.organization_id`	string	Identifier for the organization
`user.membership.display_name`	string	Display name for the organization membership
`user.membership.membership_status`	string	Status of the membership (DELETED in this case)
`user.membership.provisioning_method`	string	Method used for provisioning (JIT, org_creator, etc.)
`user.membership.created_at`	string	Timestamp of when the membership was created
`user.membership.roles`	array	Array of roles that were assigned to the user