Webhooks

The webhooks allow Uniform to notify the external systems about changes happening within your Uniform project. In a basic sense, a webhook is one or many URLs invoked by Uniform when anything in a given project is published:

• Intents
• Tests
• Compositions

Use cases

The following are examples of what you can do with webhooks:

• Trigger a build
• Regenerate the Uniform manifest

Webhook requirements

In order for Uniform to be able to use a webhook the endpoint must satisfy the following requirements:

Requirement	Value	Description
HTTP method	POST	The endpoint you specify must support this method.
Payload	None	Uniform does not provide any information to the webhook describing what was published. This means you only know that something was published, but not what exactly was published.
Response status code	200-299	If Uniform receives a response with a different status code, Uniform considers the webhook has failed. See troubleshooting a webhook for more information.
Response time	5 seconds	If Uniform does not receive a response within this amount of time, Uniform considers the webhook has failed. See troubleshooting a webhook for more information.

Create webhook

1. In Uniform, open your project.

2. Navigate to the Settings tab.

3. In the left menu, click Webhooks.

4. Enter the following values:

   Field	Description
   Name	Descriptive name for the webhook.
   URL	URL for the webhook endpoint. Uniform sends a request to this URL.

Create webhook for Netlify

If you are using Netlify to run your site build and deployment processes you might want these processes to be triggered when something is published in Uniform.

Before you start

You must have continuous deployment configured in your Netlify site in order to configure a build hook in Netlify.

1. In Netlify, open your site.

2. Navigate to Site settings > Build & deploy > Continuous Deployment > Build hooks.

   

3. Click Add build hook.

   

4. Enter the following values:

5. Click Outgoing webhook.

6. Enter the following values:

   Field	Description
   Build hook name	Descriptive name for the build hook.
   Branch to build	The build process will be triggered using the selected branch.

7. Click Save.

8. The build hook URL is displayed. Copy this value.

   

Next steps

Now you can create a webhook in Uniform that uses this URL. The result will be that whenever anything in your project is published, the build and deploy processes in Netlify will be triggered using the build hook you created in Netlify.

Create webhook for Vercel

If you are using Vercel to run your site build and deployment processes you might want these processes to be triggered when something is published in Uniform.

Before you start

You must have a Git repository configured in your Vercel project in order to configure a deploy hook in Vercel.

1. In Vercel, open your project.

2. Navigate to Settings > Git > Deploy Hooks.

   

3. Enter the following values:

   Field	Description
   Deploy hook name	Descriptive name for the build hook.
   Branch to build	The build process will be triggered using the selected branch.

4. Click Create Hook.

5. The build hook URL is displayed. Copy this value.

   

Next steps

Now you can create a webhook in Uniform that uses this URL. The result will be that whenever anything in your project is published, the build and deploy processes in Netlify will be triggered using the build hook you created in Netlify.

Delete webhook

1. In Uniform, open your project.
2. Navigate to the Settings tab.
3. In the left menu, click Webhooks.
4. Find the webhook you want to delete and click Delete.

Troubleshoot webhook

Uniform invokes webhooks during its publishing process. Details about when the publishing process was last run and which webhooks were invoked is available in the publishing history section.