@workos/openapi-spec 0.13.0 → 0.14.0

package/dist/open-api-spec.yaml

@@ -20097,6 +20097,7 @@ components:
               - permission.deleted
               - permission.updated
               - pipes.connected_account.connected
+              - pipes.connected_account.connection_failed
               - pipes.connected_account.disconnected
               - pipes.connected_account.reauthorization_needed
               - session.created
@@ -30125,6 +30126,104 @@ components:
                 - data
                 - created_at
                 - object
+            - type: object
+              properties:
+                id:
+                  type: string
+                  description: Unique identifier for the event.
+                  example: event_01EHZNVPK3SFK441A1RGBFSHRT
+                event:
+                  type: string
+                  const: pipes.connected_account.connection_failed
+                data:
+                  type: object
+                  properties:
+                    object:
+                      type: string
+                      description: The object type.
+                      example: connection_failed
+                      const: connection_failed
+                    data_integration_id:
+                      type: string
+                      description: The unique ID of the data integration.
+                      example: data_integration_01EHZNVPK3SFK441A1RGBFSHRT
+                    provider_slug:
+                      type: string
+                      description: The provider slug for this connection attempt.
+                      example: github
+                    user_id:
+                      type:
+                        - string
+                        - 'null'
+                      description: The ID of the User the connection attempt belongs to.
+                      example: user_01EHZNVPK3SFK441A1RGBFSHRT
+                    organization_id:
+                      type:
+                        - string
+                        - 'null'
+                      description: >-
+                        The ID of the Organization the connection attempt
+                        belongs to.
+                      example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
+                    error_code:
+                      type: string
+                      description: A machine-readable error code for the failure.
+                      example: authorization_code_exchange_error
+                    error_reason:
+                      type:
+                        - string
+                        - 'null'
+                      description: A human-readable explanation of the failure.
+                      example: The authorization code has expired.
+                    provider_error:
+                      type:
+                        - string
+                        - 'null'
+                      description: The raw error code returned by the OAuth provider.
+                      example: access_denied
+                    provider_error_description:
+                      type:
+                        - string
+                        - 'null'
+                      description: >-
+                        The raw error description returned by the OAuth
+                        provider.
+                      example: The user denied the authorization request.
+                    created_at:
+                      format: date-time
+                      type: string
+                      description: An ISO 8601 timestamp.
+                      example: '2026-01-15T12:00:00.000Z'
+                  required:
+                    - object
+                    - data_integration_id
+                    - provider_slug
+                    - user_id
+                    - organization_id
+                    - error_code
+                    - error_reason
+                    - provider_error
+                    - provider_error_description
+                    - created_at
+                  title: PipesConnectionFailed
+                  description: The event payload.
+                created_at:
+                  format: date-time
+                  type: string
+                  description: An ISO 8601 timestamp.
+                  example: '2026-01-15T12:00:00.000Z'
+                context:
+                  $ref: '#/components/schemas/EventContextDto'
+                object:
+                  type: string
+                  description: Distinguishes the Event object.
+                  const: event
+              required:
+                - id
+                - event
+                - data
+                - created_at
+                - object
             - type: object
               properties:
                 id:

package/dist/types.d.ts

@@ -4350,7 +4350,7 @@ export interface components {
              *       "dsync.user.created"
              *     ]
              */
-            events: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
+            events: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.connection_failed" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
         };
         UpdateWebhookEndpointDto: {
             /**
@@ -4371,7 +4371,7 @@ export interface components {
              *       "dsync.user.created"
              *     ]
              */
-            events?: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
+            events?: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.connection_failed" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
         };
         WidgetSessionTokenDto: {
             /**
@@ -12130,6 +12130,84 @@ export interface components {
              * @constant
              */
             object: "event";
+        } | {
+            /**
+             * @description Unique identifier for the event.
+             * @example event_01EHZNVPK3SFK441A1RGBFSHRT
+             */
+            id: string;
+            /** @constant */
+            event: "pipes.connected_account.connection_failed";
+            /**
+             * PipesConnectionFailed
+             * @description The event payload.
+             */
+            data: {
+                /**
+                 * @description The object type.
+                 * @example connection_failed
+                 * @constant
+                 */
+                object: "connection_failed";
+                /**
+                 * @description The unique ID of the data integration.
+                 * @example data_integration_01EHZNVPK3SFK441A1RGBFSHRT
+                 */
+                data_integration_id: string;
+                /**
+                 * @description The provider slug for this connection attempt.
+                 * @example github
+                 */
+                provider_slug: string;
+                /**
+                 * @description The ID of the User the connection attempt belongs to.
+                 * @example user_01EHZNVPK3SFK441A1RGBFSHRT
+                 */
+                user_id: string | null;
+                /**
+                 * @description The ID of the Organization the connection attempt belongs to.
+                 * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
+                 */
+                organization_id: string | null;
+                /**
+                 * @description A machine-readable error code for the failure.
+                 * @example authorization_code_exchange_error
+                 */
+                error_code: string;
+                /**
+                 * @description A human-readable explanation of the failure.
+                 * @example The authorization code has expired.
+                 */
+                error_reason: string | null;
+                /**
+                 * @description The raw error code returned by the OAuth provider.
+                 * @example access_denied
+                 */
+                provider_error: string | null;
+                /**
+                 * @description The raw error description returned by the OAuth provider.
+                 * @example The user denied the authorization request.
+                 */
+                provider_error_description: string | null;
+                /**
+                 * Format: date-time
+                 * @description An ISO 8601 timestamp.
+                 * @example 2026-01-15T12:00:00.000Z
+                 */
+                created_at: string;
+            };
+            /**
+             * Format: date-time
+             * @description An ISO 8601 timestamp.
+             * @example 2026-01-15T12:00:00.000Z
+             */
+            created_at: string;
+            context?: components["schemas"]["EventContextDto"];
+            /**
+             * @description Distinguishes the Event object.
+             * @constant
+             */
+            object: "event";
         } | {
             /**
              * @description Unique identifier for the event.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workos/openapi-spec",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "type": "module",
   "description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
   "license": "MIT",