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
Common parameters
The following POST parameters are used for most of the webhooks:
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.
Event: Project Delete
Purpose of webhook: To send a callback when a project is deleted.
Payload: The project's project.xml
file.
POST parameters:
- Common parameters:
username
,projectName
,organizationName
,organizationId
projectId
: The UUID that AtScale assigned to the imported project.
Event: Project Delete and Unpublish
Purpose of webhook: To send a callback when a project is deleted and unpublished.
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:
- Common parameters:
username
,projectName
,organizationName
,organizationId
projectId
: The UUID that AtScale assigned to the imported project.
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:
- Common parameters:
username
,projectName
,organizationName
,organizationId
projectId
: The UUID that AtScale assigned to the imported project.
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:
- Common parameters:
username
,projectName
,organizationName
,organizationId
projectId
: The UUID that AtScale assigned to the imported project.
Event: Project Publish
Purpose of webhook: To send a callback when a project is published.
Payload: The project's project.xml
file.
POST parameters:
- Common parameters:
username
,projectName
,organizationName
,organizationId
versionTag
: The description (either generated by AtScale or specified by the user) used to identify the published project.projectId
: The UUID that AtScale assigned to the project when it 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:
- Common parameters:
username
,projectName
,organizationName
,organizationId
versionTag
: The description (either generated by AtScale or specified by the user) used to identify the snapshot.
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:
- Common parameters:
username
,projectName
,organizationName
,organizationId