Create support webhook jam

POST/support/webhooks/jam/{publicKeyId}

Path parameters

publicKeyIdstringrequired

Header parameters

svix-idstringrequired

svix-timestampstringrequired

svix-signaturestringrequired

Request body

application/json

jamIdstringrequired

jamUrlstringrequired

teamIdstringrequired

typestringrequired

Allowed:videoscreenshotsessionReplay

createdAtstringrequired

titlestring

descriptionstring

originalUrlstring

originstring

isIncognitoboolean

authorobject

default: {}

Show properties

emailstring

namestring

mediaobject

default: {}

Show properties

videoUrlstring

screenshotUrlstring

thumbnailUrlstring

systemInfoobject

Show properties

browserobject

Show properties

namestring

versionstring

osobject

Show properties

namestring

versionstring

screenobject

Show properties

widthnumber

heightnumber

batteryobject

Show properties

chargingboolean

levelnumber

connectionobject

Show properties

effectiveTypestring

downlinkMbpsnumber

rttMsnumber

consoleLogsobject[]

Show properties

Array of object

levelstring

messagestring

timestampstring

networkRequestsobject[]

Show properties

Array of object

urlstring

methodstring

statusnumber

durationnumber

requestHeadersobject

responseHeadersobject

userEventsobject[]

Show properties

Array of object

typestring

timestampstring

selectorstring

targetstring

valuestring

recordingLinkobject

Show properties

publicIdstring

typestring

Allowed:one_timereusable

recordingUrlstring

descriptionstring

referencestring

submitterCommentstring

intercomobject

Show properties

conversationIdstring

issueIdstring

linearobject

Show properties

conversationIdstring

issueIdstring

Responses

200Jam captured

ticketIdstring | nullrequired

deliveryIdstring

401Invalid webhook

404Public key or ticket not found

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

publicKeyIdpath*svix-idheader*svix-timestampheader*svix-signatureheader*

Bodyapplication/json

Request body

{
  "jamId": "string",
  "jamUrl": "string",
  "teamId": "string",
  "type": "video",
  "createdAt": "string",
  "title": "string",
  "description": "string",
  "originalUrl": "string",
  "origin": "string",
  "isIncognito": true,
  "author": {},
  "media": {},
  "systemInfo": {
    "browser": {
      "name": "string",
      "version": "string",
      "property1": null,
      "property2": null
    },
    "os": {
      "name": "string",
      "version": "string",
      "property1": null,
      "property2": null
    },
    "screen": {
      "width": 0,
      "height": 0,
      "property1": null,
      "property2": null
    },
    "battery": {
      "charging": true,
      "level": 0,
      "property1": null,
      "property2": null
    },
    "connection": {
      "effectiveType": "string",
      "downlinkMbps": 0,
      "rttMs": 0,
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "consoleLogs": [
    {
      "level": "string",
      "message": "string",
      "timestamp": "string",
      "property1": null,
      "property2": null
    }
  ],
  "networkRequests": [
    {
      "url": "string",
      "method": "string",
      "status": 0,
      "duration": 0,
      "requestHeaders": {
        "property1": "string",
        "property2": "string"
      },
      "responseHeaders": {
        "property1": "string",
        "property2": "string"
      },
      "property1": null,
      "property2": null
    }
  ],
  "userEvents": [
    {
      "type": "string",
      "timestamp": "string",
      "selector": "string",
      "target": "string",
      "value": "string",
      "property1": null,
      "property2": null
    }
  ],
  "recordingLink": {
    "publicId": "string",
    "type": "one_time",
    "recordingUrl": "string",
    "description": "string",
    "reference": "string",
    "submitterComment": "string",
    "property1": null,
    "property2": null
  },
  "intercom": {
    "conversationId": "string",
    "issueId": "string",
    "property1": null,
    "property2": null
  },
  "linear": {
    "conversationId": "string",
    "issueId": "string",
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}

Request

curl -X POST "/support/webhooks/jam/string" \
  -H "svix-id: string" \
  -H "svix-timestamp: string" \
  -H "svix-signature: string" \
  -H "Content-Type: application/json" \
  -d '{
  "jamId": "string",
  "jamUrl": "string",
  "teamId": "string",
  "type": "video",
  "createdAt": "string",
  "title": "string",
  "description": "string",
  "originalUrl": "string",
  "origin": "string",
  "isIncognito": true,
  "author": {},
  "media": {},
  "systemInfo": {
    "browser": {
      "name": "string",
      "version": "string",
      "property1": null,
      "property2": null
    },
    "os": {
      "name": "string",
      "version": "string",
      "property1": null,
      "property2": null
    },
    "screen": {
      "width": 0,
      "height": 0,
      "property1": null,
      "property2": null
    },
    "battery": {
      "charging": true,
      "level": 0,
      "property1": null,
      "property2": null
    },
    "connection": {
      "effectiveType": "string",
      "downlinkMbps": 0,
      "rttMs": 0,
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  },
  "consoleLogs": [
    {
      "level": "string",
      "message": "string",
      "timestamp": "string",
      "property1": null,
      "property2": null
    }
  ],
  "networkRequests": [
    {
      "url": "string",
      "method": "string",
      "status": 0,
      "duration": 0,
      "requestHeaders": {
        "property1": "string",
        "property2": "string"
      },
      "responseHeaders": {
        "property1": "string",
        "property2": "string"
      },
      "property1": null,
      "property2": null
    }
  ],
  "userEvents": [
    {
      "type": "string",
      "timestamp": "string",
      "selector": "string",
      "target": "string",
      "value": "string",
      "property1": null,
      "property2": null
    }
  ],
  "recordingLink": {
    "publicId": "string",
    "type": "one_time",
    "recordingUrl": "string",
    "description": "string",
    "reference": "string",
    "submitterComment": "string",
    "property1": null,
    "property2": null
  },
  "intercom": {
    "conversationId": "string",
    "issueId": "string",
    "property1": null,
    "property2": null
  },
  "linear": {
    "conversationId": "string",
    "issueId": "string",
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}'

const response = await fetch("/support/webhooks/jam/string", {
  method: "POST",
  headers: {
    "svix-id": "string",
    "svix-timestamp": "string",
    "svix-signature": "string",
    "Content-Type": "application/json"
  },
  body: "{\n  \"jamId\": \"string\",\n  \"jamUrl\": \"string\",\n  \"teamId\": \"string\",\n  \"type\": \"video\",\n  \"createdAt\": \"string\",\n  \"title\": \"string\",\n  \"description\": \"string\",\n  \"originalUrl\": \"string\",\n  \"origin\": \"string\",\n  \"isIncognito\": true,\n  \"author\": {},\n  \"media\": {},\n  \"systemInfo\": {\n    \"browser\": {\n      \"name\": \"string\",\n      \"version\": \"string\",\n      \"property1\": null,\n      \"property2\": null\n    },\n    \"os\": {\n      \"name\": \"string\",\n      \"version\": \"string\",\n      \"property1\": null,\n      \"property2\": null\n    },\n    \"screen\": {\n      \"width\": 0,\n      \"height\": 0,\n      \"property1\": null,\n      \"property2\": null\n    },\n    \"battery\": {\n      \"charging\": true,\n      \"level\": 0,\n      \"property1\": null,\n      \"property2\": null\n    },\n    \"connection\": {\n      \"effectiveType\": \"string\",\n      \"downlinkMbps\": 0,\n      \"rttMs\": 0,\n      \"property1\": null,\n      \"property2\": null\n    },\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"consoleLogs\": [\n    {\n      \"level\": \"string\",\n      \"message\": \"string\",\n      \"timestamp\": \"string\",\n      \"property1\": null,\n      \"property2\": null\n    }\n  ],\n  \"networkRequests\": [\n    {\n      \"url\": \"string\",\n      \"method\": \"string\",\n      \"status\": 0,\n      \"duration\": 0,\n      \"requestHeaders\": {\n        \"property1\": \"string\",\n        \"property2\": \"string\"\n      },\n      \"responseHeaders\": {\n        \"property1\": \"string\",\n        \"property2\": \"string\"\n      },\n      \"property1\": null,\n      \"property2\": null\n    }\n  ],\n  \"userEvents\": [\n    {\n      \"type\": \"string\",\n      \"timestamp\": \"string\",\n      \"selector\": \"string\",\n      \"target\": \"string\",\n      \"value\": \"string\",\n      \"property1\": null,\n      \"property2\": null\n    }\n  ],\n  \"recordingLink\": {\n    \"publicId\": \"string\",\n    \"type\": \"one_time\",\n    \"recordingUrl\": \"string\",\n    \"description\": \"string\",\n    \"reference\": \"string\",\n    \"submitterComment\": \"string\",\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"intercom\": {\n    \"conversationId\": \"string\",\n    \"issueId\": \"string\",\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"linear\": {\n    \"conversationId\": \"string\",\n    \"issueId\": \"string\",\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"property1\": null,\n  \"property2\": null\n}"
});

import requests

response = requests.post(
    "/support/webhooks/jam/string",
    headers={
        "svix-id": "string",
        "svix-timestamp": "string",
        "svix-signature": "string",
        "Content-Type": "application/json"
    },
    data="{\n  \"jamId\": \"string\",\n  \"jamUrl\": \"string\",\n  \"teamId\": \"string\",\n  \"type\": \"video\",\n  \"createdAt\": \"string\",\n  \"title\": \"string\",\n  \"description\": \"string\",\n  \"originalUrl\": \"string\",\n  \"origin\": \"string\",\n  \"isIncognito\": true,\n  \"author\": {},\n  \"media\": {},\n  \"systemInfo\": {\n    \"browser\": {\n      \"name\": \"string\",\n      \"version\": \"string\",\n      \"property1\": null,\n      \"property2\": null\n    },\n    \"os\": {\n      \"name\": \"string\",\n      \"version\": \"string\",\n      \"property1\": null,\n      \"property2\": null\n    },\n    \"screen\": {\n      \"width\": 0,\n      \"height\": 0,\n      \"property1\": null,\n      \"property2\": null\n    },\n    \"battery\": {\n      \"charging\": true,\n      \"level\": 0,\n      \"property1\": null,\n      \"property2\": null\n    },\n    \"connection\": {\n      \"effectiveType\": \"string\",\n      \"downlinkMbps\": 0,\n      \"rttMs\": 0,\n      \"property1\": null,\n      \"property2\": null\n    },\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"consoleLogs\": [\n    {\n      \"level\": \"string\",\n      \"message\": \"string\",\n      \"timestamp\": \"string\",\n      \"property1\": null,\n      \"property2\": null\n    }\n  ],\n  \"networkRequests\": [\n    {\n      \"url\": \"string\",\n      \"method\": \"string\",\n      \"status\": 0,\n      \"duration\": 0,\n      \"requestHeaders\": {\n        \"property1\": \"string\",\n        \"property2\": \"string\"\n      },\n      \"responseHeaders\": {\n        \"property1\": \"string\",\n        \"property2\": \"string\"\n      },\n      \"property1\": null,\n      \"property2\": null\n    }\n  ],\n  \"userEvents\": [\n    {\n      \"type\": \"string\",\n      \"timestamp\": \"string\",\n      \"selector\": \"string\",\n      \"target\": \"string\",\n      \"value\": \"string\",\n      \"property1\": null,\n      \"property2\": null\n    }\n  ],\n  \"recordingLink\": {\n    \"publicId\": \"string\",\n    \"type\": \"one_time\",\n    \"recordingUrl\": \"string\",\n    \"description\": \"string\",\n    \"reference\": \"string\",\n    \"submitterComment\": \"string\",\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"intercom\": {\n    \"conversationId\": \"string\",\n    \"issueId\": \"string\",\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"linear\": {\n    \"conversationId\": \"string\",\n    \"issueId\": \"string\",\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"property1\": null,\n  \"property2\": null\n}",
)

Response

{
  "ticketId": "string",
  "deliveryId": "string"
}