Skip to content

Update webhook

Updates a webhook endpoint: its URL, events, description or whether it is sent anything. A new URL or added events need the read scopes the events' payloads carry.

Needs the organization:write scope.

Call

  • Tool: update_webhook
  • Scope: organization:write
  • Writes, and may change or remove what is there.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
webhook object Yes
url string No An https URL on a public host; redirects are never followed.
events array of "products.unlocked" or "request.received" or "request.waitlisted" or "request.approved" or "request.declined" or "request.expired" or "request.payment_due" or "discounts.unlocked" or "refund.processed" or "affiliate.earned" or "subscription.created" or "subscription.renewed" or "subscription.reminder" or "subscription.plan_changed" or "subscription.payment_failed" or "subscription.past_due" or "subscription.unpaid" or "subscription.canceled" or "subscription.reactivated" or "event.registered" or "event.updated" or "event.canceled" or "event.purchase_canceled" or "event.refund_failed" or "access.revoked" or "order.created" or "order.refunded" or "review.created" or "grant.revoked" or "certificate.issued" or "license.issued" or "license.disabled" or "license.enabled" or "license.replaced" or "license.activated" or "license.deactivated" or "license.limit_reached" or "customer.created" No The events it is sent.
description string or null No
enabled boolean No
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "webhook": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "url": {
      "description": "An `https` URL on a public host; redirects are never followed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 2048
    },
    "events": {
      "description": "The events it is sent.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "products.unlocked",
          "request.received",
          "request.waitlisted",
          "request.approved",
          "request.declined",
          "request.expired",
          "request.payment_due",
          "discounts.unlocked",
          "refund.processed",
          "affiliate.earned",
          "subscription.created",
          "subscription.renewed",
          "subscription.reminder",
          "subscription.plan_changed",
          "subscription.payment_failed",
          "subscription.past_due",
          "subscription.unpaid",
          "subscription.canceled",
          "subscription.reactivated",
          "event.registered",
          "event.updated",
          "event.canceled",
          "event.purchase_canceled",
          "event.refund_failed",
          "access.revoked",
          "order.created",
          "order.refunded",
          "review.created",
          "grant.revoked",
          "certificate.issued",
          "license.issued",
          "license.disabled",
          "license.enabled",
          "license.replaced",
          "license.activated",
          "license.deactivated",
          "license.limit_reached",
          "customer.created"
        ]
      },
      "minItems": 1,
      "maxItems": 38
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ]
    },
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "webhook"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
id string Yes
url string Yes
description string or null Yes
events array of string Yes
enabled boolean Yes
connection_ended_at string or null Yes When it was turned off because the connection that set it up ended.
created_at string Yes
updated_at string Yes

The answer’s full shape is on its API reference page.

Errors

A refused call is a tool error. Its structuredContent holds a code and its context, except for client-fault. This tool may answer:

  • invalid: an argument is malformed; context.path names it.
  • invalid at ["store"]: store is missing while the connection reaches more than one store, or names a store it doesn’t reach.
  • not_found: nothing matches a reference given.
  • conflict: the call clashes with the current state; context names the field and, where it helps, its current value, and for a from, live, expect or version that no longer matches, the argument (path) and what it takes (reason).
  • not_permitted: this connection may not make this call. When context.reason is limit, too many calls: retry_after says when to try again.
  • internal or unavailable: the call failed inside Sherpo, and the write may have landed. This write takes no idempotency key, so read the state back before trying again.
  • client-fault: the server failed around the call. core_answer ok means the write landed, so don’t send it again. When reached_core is false, nothing happened and the call may be made again. Otherwise, this write takes no idempotency key, so read the state back before trying again.
  • HTTP 403 with insufficient_scope: the connection lacks the scope this tool needs.
  • HTTP 401 with invalid_token: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.

Any other code may come back too, such as a conflict when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See Errors for every code and its context.

Type to search…

↑↓ navigate↵ selectEsc close