Webhooks for Actions on Projects

Webhooks can be configured for project-level events.

To navigate to the Webhooks page for project-level events, click Settings > Webhooks from the left-hand menu under Organization Settings. Then select Event to reveal the drop-down menu with all project webhook events.

Figure 1. The Webhook button under Organization Settings

Figure 2. Six of nine project level webhooks

You can configure project-level webhooks for the following events:

• Project Delete
• Project Delete and Unpublish
• Project Import
• Project Import - Any
• Project Publish
• Snapshot Create
• Snapshot Restore

Event: Project Delete

Purpose of webhook: To send a callback when a project is deleted.

Payload: The project's project.xml file.

POST parameters:
username
The ID of the user who deleted the project.

projectName
The name of the project that the user deleted.

projectId
The UUID that AtScale assigned to the project when it was created.

organizationName
The name of the organization from which the project was deleted.

organizationId
The UUID that AtScale assigned to the organization when the organization was created.

Event: Project Delete and Unpublish

Purpose of webhook: To send a callback when a project is deleted and unpublished.

note

Note: If you configure this webhook and the Project Delete webhook, your applications will receive two callbacks, one for each webhook.

Payload: The project's project.xml file.

POST parameters:
username
The ID of the user who unpublished and deleted the project.

projectName
The name of the project that was unpublished and deleted.

projectId
The UUID of the project that was deleted.

organizationName
The name of the organization from which the project was deleted.

organizationId
The UUID that AtScale assigned to the organization when the organization was created.

Event: Project Import

Purpose of webhook: To send a callback when a specific XML file is imported or pasted in the Design Center.

Payload: The project's project.xml file.

POST parameters:
username
The ID of the user who imported the project.

projectName
The name that the user gave to the imported project.

projectId
The UUID that AtScale assigned to the imported project.

organizationName
The name of the organization into which the project was imported.

organizationId
The UUID that AtScale assigned the organization when the organization was created.

Event: Project Import - Any

Purpose of webhook: To send a callback when any XML file is imported or pasted in the Design Center.

Payload: The project's project.xml file.

POST parameters:
username
The ID of the user who imported the project.

projectName
The name that the user gave to the imported project.

projectId
The UUID that AtScale assigned to the imported project.

organizationName
The name of the organization into which the project was imported.

organizationId
The UUID that AtScale assigned the organization when the organization was created.

Event: Project Publish

Purpose of webhook: To send a callback when a project is published.

Payload: The project's project.xml file.

POST parameters:
username
The ID of the user who published the project.

versionTag
The description (either generated by AtScale or specified by the user) used to identify the published project.

projectName
The name of the project that was published.

projectId
The UUID that AtScale assigned to the project when it was created.

organizationName
The name of the organization that the project is located in.

organizationId
The UUID that AtScale assigned to the organization when the organization was created.

Event: Snapshot Create

Purpose of webhook: To send a callback when a snapshot of a project is taken.

Payload: The project's project.xml file.

POST parameters:
username
The ID of the user who created the snapshot.

versionTag
The description (either generated by AtScale or specified by the user) used to identify the snapshot.

projectName
The name of the project that the snapshot was taken of.

organizationName
The name of the organization in which the project is located.

organizationId
The UUID that AtScale assigned to the organization when the organization was created.

Event: Snapshot Restore

Purpose of webhook: To send a callback when a project is rolled back to a previously saved version.

Payload: The project's project.xml file.

POST parameters:
username
The ID of the user who restored the snapshot.

projectName
The name of the project that was rolled back.

organizationName
The name of the organization in which the project is located.

organizationId
The UUID that AtScale assigned to the organization when the organization was created.

Related reference
Webhooks for Actions on Organizations