User Added to User Group Webhook

Triggered when a user is added to a user group.

To subscribe to this webhook, please set up a URL endpoint capable of receiving POST requests, then let your account manager know the details so we can add it to our system.

Request Details

The request will POST a JSON payload that conforms to the following Typescript interface:

interface UserAddedToUserGroupWebhookBody {
  portal: {
    id: string;
  };
  meta: {
    timestamp: string;
  };
  objectId: string;
  name: string;
  totalUsers: number;
  description: string;
  isDefaultGroup: boolean;
  userType: string;
  moderators: {
    objectId: string;
    name: string;
  }[];
  dateAdded: string;
  user: {
    id: string;
    name: string;
    email: string;
    customAttributes: Record<string, unknown>;
  };
}