Webhooks for Actions on Organizations

Webhooks can be configured for organization-level events.

To navigate to the Webhooks page for an organization, select Settings > Webhooks from the left-hand menu under Organization Settings.

Figure 1. Webhooks landing page

/public/images/webhooks_landingpage_updated.png

Figure 2. The Webhooks for Project Create, Project Import, Project Import (Any)

/public/images/project_import_select.png

Event: Project Create

Purpose of webhook: To send a callback when a project is created or imported.

Payload: The project's project.xml file.

POST parameters:

userId: The ID of the user who created the project.
name or projectName: The name that was given to the project.
organizationName: The name of the organization in which the project was created.
projectId: The UUID that AtScale assigned to the project.
organizationId: The UUID of the organization that AtScale assigned to the organization.
description: The description that was given to the project when it was created and that appears in the project's general settings.

Event: Project Import

Purpose of webhook: To send a callback when a specific project is imported from a project.xml file or from the pasting of a specific XML file.

Payload: The project's project.xml file.

POST parameters:

userId: The ID of the user who imported the project.
name or projectName: The name that was given to the project.
organizationName: The name of the organization into which the project was imported.
projectId: The UUID that AtScale assigned to the project.
organizationId: The UUID of the organization that AtScale assigned to the organization.
description: The description that was given to the project when it was imported and that appears in the project's general settings.

Event: Project Import - Any

Purpose of webhook: To send a callback when any project is imported from a project.xml file or from the pasting of any XML file.

Payload: The project's project.xml file.

POST parameters:

userId: The ID of the user who imported the project.
name or projectName: The name that was given to the project.
organizationName: The name of the organization into which the project was imported.
projectId: The UUID that AtScale assigned to the project.
organizationId: The UUID of the organization that AtScale assigned to the organization.
description: The description that was given to the project when it was imported and that appears in the project's general settings.

Event: Login Failure

Purpose of webhook: To send a callback when there is a failed attempt to log in to the Design Center; for example, incorrect user name or password.

Payload: Simply the "Bad Login" message.

POST parameters:

message
A short message about the incorrect login, including the user name used during this attempt.
organizationId
UUID of the organization to which the user tried to log in.
time
The time when the login attempt was performed, in Unix time format.

Example for the parameters in the POST request:

message: Bad Login [alicesmith]: Invalid username or password
organizationId: AtScale
time: 1643723261

More information

Webhooks for Actions on Projects