Skip to main content

Jama Connect Interchange Help

Prepare the webhook endpoint — Prerequisites (admin)

You must configure a publicly reachable HTTPS webhook endpoint that can respond to the verification challenge before you add a subscription.

Make sure the endpoint meets these requirements. The webhook server handles the verification request in this order:

  1. Accepts an HTTPS POST request with a JSON body.

  2. Checks whether the event type is VERIFICATION.

  3. Reads the challenge value from the request body.

  4. Returns that exact challenge value in the HTTPS response.

  5. Returns an HTTPS 200 OK status.

Verification payload example:

 {  
  "specversion": "1.0",  
  "messageid": "<uuid>",  
  "messagetype": "event",  
  "tenantname": "<tenant>",  
  "webhookurl": "https://customer-domain.com/webhook",  
  "timestamp": "<ISO-8601 timestamp>",  
  "eventtype": "VERIFICATION",  
  "data": {    
    "challenge": "<challenge value>",    
    "expiresat": "<ISO-8601 timestamp>"  
 }
}

Important

Do not wrap the challenge in a JSON object or add a prefix, suffix, or other content. After verification succeeds, the webhook URL can receive ordinary event notifications. When you add a new subscription in Jama Connect Interchange, copy and securely store the signature key because it is displayed only once.

  • The webhook endpoint is publicly reachable over HTTPS.

  • The webhook endpoint accepts HTTPS POST requests with JSON request bodies.

Note

Local URLs, including localhost and 127.0.0.1, aren’t supported.

Example webhook URL: https://customer-domain.com/webhook

In this section: