Tightknit Community Icon

Webhook Payload Update: Calendar Event User Registration Changes

Β·
Β·

Webhook Payload Property Deprecation We are modifying the shape of the payload for the Calendar Event User Registration and Calendar Event User Unregistration webhooks. The properties in the user.slack_profile object will now be top-level properties with the name slack_<original_name>. The user.slack_profile object will still be included in the payloads to allow backwards compatibility during the transition time. The user.slack_profile object will be removed from these payloads on April 1, 2025. Please migrate your processes to use the new fields by this date. As an example, the following is the old shape of the user registration webhook payload:

{
  action: 'calendar_event.user_registered',
  user: {
    id: "123456";
    slack_profile: {
      id: "U088HCYD418",
      is_admin: true,
      first_name: "John",
      ...
    }
  }
}

and during the transition period, the payload will retain the redundant fields in the slack_profile :

{
  action: 'calendar_event.user_registered',
  user: {
    profile_id: "123456",
    slack_user_id: "U088HCYD418",
    slack_is_admin: true,
    slack_first_name: "John",
    ...
    slack_profile: {
      deprecated: true,
      warning: 'The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.',
      id: string,
      is_admin: true,
      first_name: "John",
      ...
    }
  }
}

You can always view the latest docs on our webhooks here (and soon-to-be on our API Reference). Please reach out if you need guidance moving to the new payload shape!