Project-Scoped
This page walks you through how to create each project-scoped Alert Destination.
Project-scoped Destinations are only accessible within the project they were created.
trigger:
type: alert
alert: {}
A single action can be used as a destination for multiple alerts.
This alert destination allows for execution of your webhook when an alert is triggered. Your webhook will receive a signed payload, containing the transaction object that triggered the alert.
After adding a Webhook as an alert destination, you can use it as destination for other alerts.
- It must expose a GET method with the webhook URI, that immediately returns
HTTP 200. Tenderly makes a request to this method to verify the webhook is reachable. - It must expose a POST method with the same webhook URI. The webhook will receive a payload described below.
- Unless a
HTTP 200doesn't respond within 5 seconds, Tenderly considers this as a failed webhook execution. - The webhook URL must use HTTPS.
The Webhook must respond within 5 seconds time-frame. If there's no response, the execution is considered failed.
Tenderly keeps track of all executions. Webhook execution can have several statuses:
- Success - indicates that the webhook was successfully executed and the event was delivered to the specified URL
- Failed - indicates that the webhook was unable to be executed due to an error, such as a connectivity issue, a problem with the URL, or something else (check the response content to see what caused the error or contact our support)
- Pending - indicates that the webhook is in the process of being executed and has not yet been completed
- Retry - indicates that the webhook execution failed but will be retried no more than 5 times until it changes the status to Sucess or Failed
- Skipped - indicates that the webhook was not executed because it was disabled
The webhook will receive the payload representing the alerting event. The payload consists of three fields:
- id:
String- ID unique accross all delivered alert events (UUID). - event_type:
TEST|ALERT- the type of webhook event type. - transaction:
Object- an object representing an un-decoded transaction that triggered the alert and the webhook execution.
Upon adding the webhook as an alert destination, it will be invoked with a
TEST alert event type. Use the
id field to ensure your webhook processes each alert event exactly once, by keeping track of processed IDs.You can enhance security of your webhooks using the signature validation method. This way, you can verify that the request to webhook originates from Tenderly, before proceeding with the execution.
The
x-tenderly-signature header contains a cryptographic signature. The webhook request signature is a HMAC SHA256 hash of concatenated signing secret, request payload, and timestamp, in this order.The Signing Secret is unique for each webhook destination. Tenderly generates this secret and uses it to generat a sigunature for the payload. Keep it at a safe place.
Step 1. Obtain the Secret Signing Secret.
Copying secret signing key
Step 2. Validate the received signature
To validate the received signature, concatenate, in this order:
- 1.the signing secret,
- 2.the entire webhook request payload,
- 3.the timestamp (of the payload).
Lastly, perform a SHA 256 hash on the concatenated value.
Go
JavaScript
Python
func isValidSignature(
signature string,
payload []byte,
timestamp string,
) bool {
h := hmac.New(sha256.New, []byte(signingKey))
h.Write(payload)
h.Write([]byte(timestamp))
digest := hex.EncodeToString(h.Sum(nil))
return digest == signature
}
function isValidSignature(signature, payload, timestamp) {
// Create a HMAC SHA256 hash using the signing key
const hmac = crypto.createHmac("sha256", signingKey);
// Update the hash with the request body using utf8
hmac.update(payload.toString(), 'utf8');
// Update the hash with the request timestamp
hmac.update(timestamp);
const digest = hmac.digest("hex");
return crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(digest))
}
def isValidSignature(signature: string, payload: bytes, timestamp: string):
h = hmac.new(str.encode(signingKey), payload, hashlib.sha256)
h.update(str.encode(timestamp))
digest = h.hexdigest()
return hmac.compare_digest(signature, digest)
To support debugging of webhook malfunctions, you can manually send
TEST events, based on existing transactions from any networkStep 1. Click "Test Webhook" in the navigation bar of the webhooks page.
Webhook overview
Step 2. Paste a hash of a transaction that matches your alert's trigger
Testing webhook: paste the transaction hash
Step 3. Click "Test Webhook" to confirm and send the test event.
Your webhook will be invoked with the transaction corresponding to the hash you pasted, and event_type of
TEST. You'll be presented with overview of that execution.
Result of a manual (test) execution of a webhook
Last modified 2mo ago