Set Up Project Webhooks

On this page

TestCollab is a test management tool where teams keep test cases, organize test runs, and record results. Webhooks send an HTTPS request to your integration when a project record changes, so your team can update a dashboard or trigger a workflow without repeatedly checking the API.

An endpoint is the URL that receives those requests. You choose which events each endpoint receives, such as a test case update or a test execution status change.

Before you start

• You need the Administrator role to manage Webhooks.
• Webhooks must be available for your account. If an Administrator cannot see Webhooks in project Settings, contact TestCollab support to check availability.
• Prepare a public HTTPS receiver that accepts JSON POST requests and verifies the project signing secret. Localhost and private network addresses cannot receive deliveries directly.

The request uses TestCollab's signed envelope. A third-party URL must support that format, or you will need an adapter in front of it. See Webhook Events and Signature Verification for the receiver contract.

Enable Webhooks for a project

1. Open the project, then go to Settings > General.
2. Turn on Enable Webhooks and save your settings.
3. Open Settings > Webhooks, below Import & Migration.

Webhooks has three tabs:

• Endpoints: configure receivers and the shared signing secret.
• Events: inspect recorded changes and browse the event catalog.
• Delivery logs: inspect delivery attempts and retry failed deliveries.

Generate the shared signing secret

1. In Endpoints, select Generate shared secret.
2. Select Copy in the dialog and store the secret securely. It is shown only once.
3. Configure every receiver for this project with that secret, then close the dialog.

All endpoints in one project share the same secret. Each project has its own secret. The card shows the current version and generation date, but does not reveal the saved secret again.

If you lose the secret or need to replace it, select Reset shared secret and confirm. Copy the new value and update every receiver in the project. New attempts use the new secret, including retries of older events. Coordinate this change with the people maintaining your receivers.

Add an endpoint

1. In Endpoints, select Add webhook.
2. Enter a name that identifies the integration, such as Release dashboard.
3. Enter the receiver's HTTPS URL. Use its final public URL, without a username, password, or URL fragment.
4. Select one or more Events that the receiver needs.
5. Set Timeout (seconds) from 1 to 30. The default is 10 seconds.
6. Set Maximum total attempts from 1 to 3. The default is 3, including the first send and up to two automatic retries for temporary failures.
7. Leave Enabled on when the receiver is ready, then select OK.

A project can have up to 100 endpoints. A new endpoint receives future matching events; adding one does not send it earlier project history.

Test and edit an endpoint

Open the endpoint's ellipsis menu in the Actions column:

• Edit: change its name, URL, subscriptions, timeout, or attempt limit.
• Send test: send a synthetic webhook.test event and open its delivery result. This makes one attempt and does not change a real test case or test plan.
• Delete: remove the endpoint after confirmation. Delivery history and the shared project secret are retained.

Send test is available when the project and endpoint are enabled and a shared secret exists. After it succeeds, make a small real change matching one of your subscriptions to check the receiver's handling of business events. For failures, see Troubleshoot and Retry Webhook Deliveries.

Copy endpoints from another project

1. Open the destination project's Webhooks > Endpoints tab and select Copy from another project.
2. Select a source project in the same company. Webhooks must be enabled in both projects, and the source must have endpoints to copy.
3. Review the selected endpoints. Existing matches with the same URL and event subscriptions start unselected to help avoid duplicate deliveries.
4. Adjust each selected URL, timeout, or attempt limit. To change the timeout or attempt limit for several rows together, use Apply to all selected.
5. Select Copy, then review and test the new endpoints.

The copy preserves each endpoint's name, event subscriptions, and enabled state. It does not copy the source project's signing secret or delivery history. Configure the receivers to use the destination project's shared secret.

Disable and re-enable Webhooks

To stop one endpoint, turn off its switch in the Enabled column. To stop all Webhooks for the project, turn off Enable Webhooks in Settings > General and save.

Disabling cancels queued deliveries and scheduled retries for the affected endpoints. An HTTP request already in progress may still finish. Endpoint configuration and recorded history remain available; project-wide disabling also stops recording new business events.

Re-enabling resumes delivery of new matching events. It does not automatically replay the old backlog or changes made while delivery was disabled. A previously failed delivery can still be retried explicitly after the project and endpoint are enabled again. Cancelled deliveries do not have a Retry action.