The broadcast object
Attributes
Creates a new broadcast message. When a broadcast is created, it generates individual notifications for relevant users within the project. Only administrators can create broadcasts.
Request body
Saves a mobile_push token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel.
Request body
production.Lists all mobile_push tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata.
Query parameters
Retrieves details of a specific mobile_push token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens.
Path parameters
Revokes one of the authenticated user's mobile_push tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens.
Path parameters
Saves a mobile_push token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel.
Request body
Lists all mobile_push tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata.
Query parameters
Retrieves details of a specific mobile_push token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens.
Path parameters
Revokes one of the authenticated user's mobile_push tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens.
Path parameters
Saves a mobile_push token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel.
Request body
Lists all mobile_push tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata.
Query parameters
Retrieves details of a specific mobile_push token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens.
Path parameters
Revokes one of the authenticated user's mobile_push tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens.
Path parameters
Saves a slack token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel.
Request body
Lists all slack tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata.
Query parameters
Retrieves details of a specific slack token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens.
Path parameters
Revokes one of the authenticated user's slack tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens.
Path parameters
Saves a teams token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel.
Request body
Lists all teams tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata.
Query parameters
Retrieves details of a specific teams token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens.
Path parameters
Revokes one of the authenticated user's teams tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens.
Path parameters
Saves a web_push token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel.
Request body
Lists all web_push tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata.
Query parameters
The event object
Attributes
The integration object
Attributes
List Integrations
Lists all available and configured integrations for the project. Returns a summary of each integration including its type, status, and basic configuration information.
Query parameters
Creates or updates a apns integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current apns integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a apns integration configuration from the project. This will disable the integration's functionality within the project.
Creates or updates a awssns integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current awssns integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a awssns integration configuration from the project. This will disable the integration's functionality within the project.
Receives and processes incoming webhook events from the awssns integration. Each integration can define its own webhook payload format and handling logic.
Path parameters
Request body
Removes a specific awssns integration instance by ID from the project.
Path parameters
Creates or updates a expo integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current expo integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a expo integration configuration from the project. This will disable the integration's functionality within the project.
Creates or updates a fcm integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current fcm integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a fcm integration configuration from the project. This will disable the integration's functionality within the project.
Creates or updates a github integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current github integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a github integration configuration from the project. This will disable the integration's functionality within the project.
Receives and processes incoming webhook events from the github integration. Each integration can define its own webhook payload format and handling logic.
Path parameters
Request body
Removes a specific github integration instance by ID from the project.
Path parameters
Creates or updates a inbox integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current inbox integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a inbox integration configuration from the project. This will disable the integration's functionality within the project.
Creates a new installation of a inbox integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.
Request body
Initiates the installation flow for a inbox integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required.
Removes a specific inbox integration instance by ID from the project.
Path parameters
Creates or updates a mailgun integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current mailgun integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a mailgun integration configuration from the project. This will disable the integration's functionality within the project.
Removes a specific mailgun integration instance by ID from the project.
Path parameters
Creates or updates a ping_email integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current ping_email integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a ping_email integration configuration from the project. This will disable the integration's functionality within the project.
Removes a specific ping_email integration instance by ID from the project.
Path parameters
Creates or updates a sendgrid integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current sendgrid integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a sendgrid integration configuration from the project. This will disable the integration's functionality within the project.
Removes a specific sendgrid integration instance by ID from the project.
Path parameters
Creates or updates a ses integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current ses integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a ses integration configuration from the project. This will disable the integration's functionality within the project.
Creates or updates a slack integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current slack integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a slack integration configuration from the project. This will disable the integration's functionality within the project.
Creates a new installation of a slack integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.
Request body
Completes the installation flow for a slack integration. This endpoint is typically called after the user has completed any required authorization steps with slack.
Request body
Initiates the installation flow for a slack integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required.
Request body
Removes a specific slack integration instance by ID from the project.
Path parameters
Creates or updates a stripe integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current stripe integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a stripe integration configuration from the project. This will disable the integration's functionality within the project.
Receives and processes incoming webhook events from the stripe integration. Each integration can define its own webhook payload format and handling logic.
Path parameters
Request body
Removes a specific stripe integration instance by ID from the project.
Path parameters
Creates or updates a templates integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current templates integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a templates integration configuration from the project. This will disable the integration's functionality within the project.
Creates a new installation of a templates integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.
Request body
Removes a specific templates integration instance by ID from the project.
Path parameters
Creates or updates a twilio integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current twilio integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a twilio integration configuration from the project. This will disable the integration's functionality within the project.
Removes a specific twilio integration instance by ID from the project.
Path parameters
Creates or updates a web_push integration for the project. Only administrators can configure integrations.
Request body
Retrieves the current web_push integration configurations for a specific integration type in the project. Returns configuration details and status information.
Removes a web_push integration configuration from the project. This will disable the integration's functionality within the project.
Creates a new installation of a web_push integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration.
Request body
Creates a new project-level JWT token. These tokens provide project-wide access and should be carefully managed. Only administrators can create project tokens. The returned token should be securely stored as it cannot be retrieved again after creation.
Request body
Retrieves a list of all active project-level JWT tokens. Returns a paginated list showing token metadata including creation date, last used date, and expiration time. For security reasons, the actual token values are not included in the response.
Query parameters
Immediately revokes a project-level JWT token. Once revoked, any requests using this token will be rejected. This action is immediate and cannot be undone. Active sessions using this token will be terminated.
Path parameters
Issues a new user-specific JWT token. These tokens are scoped to individual user permissions and access levels. Only administrators can create user tokens. The token is returned only once at creation time and cannot be retrieved later.
Request body
Revokes a specific user's JWT token. This immediately invalidates the token and terminates any active sessions using it. This action cannot be undone. Administrators should use this to revoke access when needed for security purposes.
Path parameters
Lists all JWT tokens associated with a specific user. Returns token metadata including creation time, last access time, and expiration date. Administrators can use this to audit user token usage and manage active sessions. Token values are not included in the response for security reasons.
Path parameters
Query parameters
The user object
Attributes
Lists all mobile_push tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
Path parameters
Query parameters
Retrieves a specific mobile_push token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
Path parameters
Revokes a specific user's mobile_push token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
Path parameters
Lists all mobile_push tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
Path parameters
Query parameters
Retrieves a specific mobile_push token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
Path parameters
Revokes a specific user's mobile_push token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
Path parameters
Lists all mobile_push tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
Path parameters
Query parameters
Retrieves a specific mobile_push token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
Path parameters
Revokes a specific user's mobile_push token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
Path parameters
Lists all slack tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
Path parameters
Query parameters
Retrieves a specific slack token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
Path parameters
Revokes a specific user's slack token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
Path parameters
Lists all teams tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
Path parameters
Query parameters
Retrieves a specific teams token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
Path parameters
Revokes a specific user's teams token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.
Path parameters
Lists all web_push tokens associated with a specific user. This endpoint is available to project administrators and returns a paginated list of tokens, including both active and revoked tokens.
Path parameters
Query parameters
Retrieves a specific web_push token by its ID for a given user. This endpoint is available to project administrators and requires project-level authentication. Use this to inspect token details including its status, creation date, and associated metadata.
Path parameters
Revokes a specific user's web_push token. This endpoint is available to project administrators and permanently invalidates the specified token. Once revoked, the token can no longer be used to access channel features. This action cannot be undone.