Update a webhook target

Change a target’s URL, pause it, or move it to a newer schema version.

Update an existing webhook target. For example to change the URL, pause deliveries by setting isEnabled to false, change which events are delivered, or move to a newer schema version.

For TypeScript, the GraphQL SDK gives you a fully typed client for these operations.

Field-level wrapper inputs apply for scalar fields. Pass { "value": ... } for the fields you want to change. eventSubscriptions is the exception: it’s a full replacement of the previous list, so include every event type the target should subscribe to.

Mutation

mutation updateWebhookTarget($input: UpdateWebhookTargetInput!) {
  updateWebhookTarget(input: $input) {
    webhookTarget {
      id
      url
      isEnabled
      eventSubscriptions {
        eventType
      }
    }
    error {
      message
      type
      code
      fields {
        field
        message
        type
      }
    }
  }
}

Variables

{
  "input": {
    "webhookTargetId": "wt_01HXXXXXXXXXXXXXXXXXXXXXXX",
    "isEnabled": { "value": false }
  }
}