Use the Webhooks page of the Dashboard to manage your webhooks and retrieve your secret keys.

The Status column shows the state of each endpoint:

• Not Executed: The platform has not sent a notification to the endpoint yet.
• Success: The endpoint responded to the most recent notification with a 2xx status code.
• Failed: The endpoint did not respond to the most recent notification with a 2xx status code. The status returns to Success after the next successful delivery. If you see this status, review the Requirements for processing notifications page.

Register a webhook

Register your endpoint before the platform can send notifications to it.

1. Go to the Webhooks page.
2. Select the Add Endpoint button.
3. In the Add webhook endpoint modal, enter the URL of your endpoint and a brief description.
4. Select the Add button. The Status column shows Not Executed until the platform sends the first notification and the endpoint responds with a 2xx status code.

Retrieve your secret key

TwelveLabs signs each notification. Retrieve your secret key from the Dashboard to verify the signatures.

1. Go to the Webhooks page.
2. Find the webhook and select the Reveal Secret button.
3. Select the copy icon to the right of the secret key.

Enable or disable a webhook

Disable a webhook to suspend notifications without removing the registration. Enable it again to resume.

1. Go to the Webhooks page.
2. Find the webhook and use the toggle in the Enabled column.

Remove a webhook

Remove a webhook when the endpoint is no longer needed.

1. Go to the Webhooks page.
2. Find the webhook and select the trash icon at the far right of the row.