Project-Scoped

​

Web3 Actions

trigger:
  type: alert
  alert: {}

​

Webhooks

​

webhook की आवश्यकताएँ:

• यह webhook URL पर पहुंच योग्य अवश्य होना चाहिए: webhook जोड़ते समय, Tenderly पहुंच सत्यापित करने के लिए एक GET request भेजता है। कोई भी HTTP response verification पास करता है; verification केवल transport errors (DNS, TCP, TLS, या 2 सेकंड के भीतर कोई response नहीं) पर विफल होता है।
• इसे उसी webhook URI के साथ एक POST method अवश्य उजागर करना चाहिए। Webhook को नीचे वर्णित payload प्राप्त होगा।
• जब तक webhook 10 सेकंड के भीतर 2xx status के साथ response नहीं देता, delivery विफल मानी जाती है।
• webhook URL के लिए HTTPS का उपयोग करने की दृढ़ता से अनुशंसा की जाती है।

• Success - इंगित करता है कि webhook सफलतापूर्वक निष्पादित किया गया था और event को निर्दिष्ट URL पर वितरित किया गया था
• Failed - इंगित करता है कि किसी error के कारण webhook को निष्पादित नहीं किया जा सका, जैसे कि connectivity समस्या, URL के साथ समस्या, या कुछ और (यह देखने के लिए कि error का कारण क्या था, response content जांचें या हमारे support से संपर्क करें)
• Pending - इंगित करता है कि webhook निष्पादित होने की प्रक्रिया में है और अभी तक पूरा नहीं हुआ है
• Retry - इंगित करता है कि webhook निष्पादन विफल हो गया और पुनः प्रयास किया जाएगा; एक event कुल अधिकतम 5 प्रयासों में deliver होता है, जिसके बाद status Success या Failed पर स्थिर हो जाता है
• Skipped - इंगित करता है कि webhook निष्पादित नहीं किया गया था क्योंकि यह disabled था

​

Webhook payload

• id: String - सभी delivered alert events में अद्वितीय ID (UUID)।
• event_type: TEST | ALERT - webhook event type का प्रकार।
• alert_id: String - उस alert का ID जिसके rule ने यह event trigger किया। TEST events के लिए खाली।
• transaction: Object - एक un-decoded transaction का प्रतिनिधित्व करने वाला object जिसने alert और webhook निष्पादन को ट्रिगर किया।

​

Webhook को सुरक्षित करना

1. संपूर्ण webhook request payload,
2. timestamp (request के Date header से)।

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)

​

Webhook निष्पादनों का Debugging