Project Integration Workflow
Use Unity Build Automation (UBA) to connect your Unity Cloud project with external services so you can automatically receive notifications about build statuses and other important events. These integrations help streamline your workflow by keeping your team informed in real time.
To create a new project integration, complete the following tasks:
- Access project integrations
- Create the integration
- Subscribe to services and events
- Save the integration
- Test your integration
- Edit and manage your integration
Access Project Integrations
The Project integrations page displays a list of all configured integrations for your project, along with their current status:
- In the Unity Dashboard, select the Administration tab.
- Under Integrations, select Project Integrations.
Supported Integrations
UBA currently supports the following integrations:
- Discord
- Microsoft Teams
- Slack
- Webhook
Note: For advanced configuration, such as to customize Slack message formatting, refer to the documentation of the specific service you're integrating with.
Create the Integration
- On the Project integrations page, select New integration.
- Select the integration type you want to set up from the dropdown menu.
- Enter the connection details and settings for your chosen integration service.
Configure a Webhook Integration
For third-party integrations that use a custom webhook to send notifications, you need to configure the following fields:
| Field | Description |
|---|---|
| Display name | A name to identify your webhook integration. |
| Webhook URL | The endpoint where UBA sends HTTP POST requests. Ensure this URL is accessible from the public internet or your private network, depending on your setup. |
| Authorization secret (optional) | A secret token that UBA includes in the request headers or payload, depending on your chosen Authorization type. Use this secret token to verify that incoming requests originate from UBA. |
| Authorization type | The way that UBA sends the authorization secret: _ Shared secret: UBA includes the secret in a header or payload field ( this varies by service). _ Other options might appear depending on your setup. |
| Content type | The format UBA uses to send the data. For example, application/json. |
| Disable SSL/TLS verification (optional) | If enabled, UBA doesn't validate the SSL certificate. This can be useful for local testing or self-signed certificates, but isn't recommended for production environments. |
Note: Some services require a shared secret or token to verify that incoming requests are legitimate. Make sure you configure this correctly on both the Unity side and your external service side.
Subscribe to Services and Events
When you configure an integration, select which services and events to subscribe to and receive notifications for. For UBA, you can select from the following events:
- Build Success
- Build Failure
- Build Queued
- Build Started
- Build Canceled
- Build Restarted
- Uploaded Local Build
Note: Only subscribe to events you need. If you subscribe to every event, it might cause unnecessary noise in your channels.
Save the Integration
Select Create to add your new integration to your Project Integrations list.
Note: For a Slack or Discord integration, select Authenticate & create to authenticate with the external service before you save the integration.
Test your Integration
- Trigger a build in Unity Build Automation. For example, commit code or manually starting a build.
- Verify that your external service, such as a Slack or Discord channel, receives the corresponding notification.
Edit and Manage your Integration
After creating an integration, you can manage the integration from the Project Integrations page:
- Edit: Update the integration's name, webhook URL, or the events you subscribe to.
- Disable: Temporarily disable notifications without removing the integration entirely.
- Delete: Permanently remove the integration from your project.