---
title: Get webhook
slug: webhook-api/get-webhook
docTags: 
createdAt: 2024-06-10T16:49:31.068Z
---

{
  "id": "q-hHqqVT_NfjYilUYyHyF",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.catenda.com/v2/projects/{project-id}/webhooks/user/{webhook-id}",
    "servers": [
      {
        "url": "https://api.catenda.com/v2/projects/{project-id}/webhooks/user/{webhook-id}"
      }
    ],
    "name": "Get webhook",
    "description": "Get a single webhook subscription.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "project-id",
          "type": "string",
          "example": "af2d8af0fa54465b89bf26dd3d92cfd0",
          "description": "Catenda project id"
        },
        {
          "kind": "required",
          "name": "webhook-id",
          "type": "string",
          "description": "Id of the webhook"
        }
      ],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "Bearer",
          "name": "Bearer",
          "kind": "optional",
          "type": "http",
          "scheme": "bearer"
        }
      ]
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "Represents the subscription to an event with an associated callback.",
            "customType": "webhook-subscription",
            "schema": [
              {
                "name": "id",
                "kind": "optional",
                "type": "string",
                "description": "A unique identifier for a Webhook, represented as compacted UUID using 32 hexadecimal characters",
                "example": "57d5457e09d64380af75da94ed96557h"
              },
              {
                "name": "target_url",
                "kind": "optional",
                "type": "string",
                "description": "The URL to be called when the event occurs",
                "example": "https://hooks.zapier.com/hooks/catch/1028857/a8w0or/"
              },
              {
                "name": "createdAt",
                "kind": "optional",
                "type": "string",
                "description": "Creation date of the Webhook",
                "example": "2019-02-13T14:15:18Z\""
              },
              {
                "name": "state",
                "kind": "optional",
                "type": "string",
                "description": "The state of the Webhook.\n\nValid values are: \n  - ENABLED\n  - DISABLED_GONE\n  - DISABLED_TOO_MANY_FAILURES\n  - DISABLED_BY_USER\n",
                "example": ""
              },
              {
                "name": "failureCount",
                "kind": "optional",
                "type": "number",
                "description": "The number of times the Webhook has failed",
                "example": 0
              },
              {
                "name": "event",
                "kind": "optional",
                "type": "string",
                "description": "The event that triggers the callback URL.\n\nValid values are: \n  - issue.created\n  - issue.deleted\n  - issue.modified\n  - issue.status.changed\n  - library.document.revision.published\n  - model.created\n  - revision.created\n",
                "example": "issue.created"
              }
            ],
            "modelRef": "#/components/schemas/webhook-subscription",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "CWgjoVC59Ps1fTes2XLWA",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.catenda.com/v2/projects/{project-id}/webhooks/user/{webhook-id} \\\n     --header 'accept: application/json'"
        },
        {
          "id": "A3Jz-IcHM9QjlVvsr73Pq",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.catenda.com/v2/projects/{project-id}/webhooks/user/{webhook-id}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "r7F8EksB_X6Xn5Wx5nXD0",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.catenda.com/v2/projects/{project-id}/webhooks/user/{webhook-id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "yBpQYVsE_YlOdVjmoRy1h",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.catenda.com/v2/projects/{project-id}/webhooks/user/{webhook-id}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "CWgjoVC59Ps1fTes2XLWA"
    },
    "results": {
      "languages": [
        {
          "id": "F2XgFRNfl6E595RwedNx0",
          "language": "200",
          "code": "// OK\n{\n  \"id\": \"57d5457e09d64380af75da94ed96557h\",\n  \"target_url\": \"https://hooks.zapier.com/hooks/catch/1028857/a8w0or/\",\n  \"createdAt\": \"2019-02-13T14:15:18Z\\\"\",\n  \"state\": \"\",\n  \"failureCount\": 0,\n  \"event\": \"issue.created\"\n}"
        }
      ],
      "selectedLanguageId": "F2XgFRNfl6E595RwedNx0"
    }
  },
  "children": [
    {
      "id": "Py9EZMwm6HaAczYllAkzP",
      "type": "paragraph",
      "children": [
        {
          "text": "Get a single webhook subscription."
        }
      ]
    }
  ]
}