updateWebhookEndpoint

Requires permission settings:webhooks:update.

Updates a webhook endpoint's name, receiver URL, subscribed events or active state. The same URL and event rules as creation apply, and the signing secret is not changed. Requires permission to update webhooks.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation UpdateWebhookEndpoint($id: ID!, $input: WebhookEndpointInput!) {
  updateWebhookEndpoint(id: $id, input: $input) {
    id
    name
    createdAt
    eventTypes
    isActive
    secretHint
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateWebhookEndpoint($id: ID!, $input: WebhookEndpointInput!) {\n  updateWebhookEndpoint(id: $id, input: $input) {\n    id\n    name\n    createdAt\n    eventTypes\n    isActive\n    secretHint\n  }\n}",
  "variables": {
    "id": "id",
    "input": {
      "eventTypes": [
        "string"
      ],
      "name": "string",
      "url": "string"
    }
  }
}
EOF

Variables:

{
  "id": "id",
  "input": {
    "eventTypes": [
      "string"
    ],
    "name": "string",
    "url": "string"
  }
}

Response:

{
  "data": {
    "updateWebhookEndpoint": {
      "id": "id",
      "name": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "eventTypes": [
        "string"
      ],
      "isActive": true,
      "secretHint": "string"
    }
  }
}

updateWebhookEndpoint(
  id: ID!
  input: WebhookEndpointInput!
): WebhookEndpoint!

Arguments

updateWebhookEndpoint.id ● ID! non-null scalar

The ID of the webhook endpoint.

updateWebhookEndpoint.input ● WebhookEndpointInput! non-null input

The endpoint's name, receiver URL, subscribed event types and whether it is active.

Type

WebhookEndpoint object

A webhook endpoint of the organization. The signing secret is never a field here.