Skip to content

Add authorization event and webhook types#551

Open
csrbarber wants to merge 1 commit intofeature/ent-4799-workos-python-env-rolesfrom
feature/ent-4799-workos-python-events
Open

Add authorization event and webhook types#551
csrbarber wants to merge 1 commit intofeature/ent-4799-workos-python-env-rolesfrom
feature/ent-4799-workos-python-events

Conversation

@csrbarber
Copy link
Contributor

Description

Add event and webhook types for organization_role (created, updated, deleted) and permission (created, updated, deleted) to support authorization-related event streaming and webhook delivery.

Documentation

Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.

[X] Yes

If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.

Add event and webhook types for organization_role (created, updated,
deleted) and permission (created, updated, deleted) to support
authorization-related event streaming and webhook delivery.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@csrbarber csrbarber requested a review from a team as a code owner February 13, 2026 15:44
@csrbarber csrbarber requested review from gjtorikian and removed request for a team February 13, 2026 15:44
@linear
Copy link

linear bot commented Feb 13, 2026

ENT-4799 workos-python

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 13, 2026

Greptile Overview

Greptile Summary

Added complete event and webhook type support for authorization-related resources (organization_role and permission). The changes include:

  • Created six new event classes: OrganizationRoleCreatedEvent, OrganizationRoleUpdatedEvent, OrganizationRoleDeletedEvent, PermissionCreatedEvent, PermissionUpdatedEvent, PermissionDeletedEvent
  • Created corresponding webhook classes with identical naming pattern
  • Registered all new types in discriminated unions for proper type discrimination
  • Added OrganizationRole and Permission to EventPayload TypeVar
  • Added corresponding event type literals to EventType

The implementation follows existing patterns consistently, using EventModel[OrganizationRole] and EventModel[Permission] generics, Literal discriminators, and proper alphabetical ordering in unions. All imports reference existing authorization types from workos/types/authorization/.

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • Changes are purely additive type definitions following established patterns exactly - no logic, no security concerns, no breaking changes, just new event/webhook types for authorization features
  • No files require special attention

Important Files Changed

Filename Overview
workos/types/events/event_type.py Added six new event type literals for organization_role and permission events (created, updated, deleted)
workos/types/events/event_model.py Added OrganizationRole and Permission imports and to EventPayload TypeVar for type safety
workos/types/events/event.py Added six event classes and registered them in Event union for authorization role and permission events
workos/types/webhooks/webhook.py Added six webhook classes and registered them in Webhook union for authorization role and permission webhooks

Sequence Diagram

sequenceDiagram
    participant Client as SDK Client
    participant API as WorkOS API
    participant Webhook as Webhook Handler
    
    Note over Client,API: Authorization Resource Operations
    Client->>API: Create/Update/Delete OrganizationRole
    API-->>Client: OrganizationRole response
    API->>Webhook: organization_role.created/updated/deleted event
    Webhook->>Webhook: Parse OrganizationRoleWebhook type
    
    Client->>API: Create/Update/Delete Permission
    API-->>Client: Permission response
    API->>Webhook: permission.created/updated/deleted event
    Webhook->>Webhook: Parse PermissionWebhook type
    
    Note over Webhook: Both event types use discriminated unions<br/>for type-safe deserialization
Loading

Last reviewed commit: 94a09eb

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants