Skip to main content
PATCH
/
2025-09
/
webhook_endpoints
/
{webhook_endpoint_id}
Update a Webhook Endpoint
curl --request PATCH \
  --url https://public-api.stora.co/2025-09/webhook_endpoints/{webhook_endpoint_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Webhook Name",
  "url": "https://example.com/updated_webhook",
  "event_types": [
    "credit_note.created"
  ],
  "description": "An updated webhook endpoint",
  "metadata": {
    "source": "updated"
  }
}
'
{
  "endpoint": {
    "id": "we_195h6kfm9ro15lof",
    "api_version": "2025-09",
    "created_at": "2025-02-22T14:41:00Z",
    "creator": {
      "id": "staff_06778802edebb94d"
    },
    "description": "An updated webhook endpoint",
    "disabled_at": null,
    "event_types": [
      "credit_note.created"
    ],
    "metadata": {
      "source": "updated"
    },
    "name": "Updated Webhook Name",
    "secret": null,
    "status": "enabled",
    "updated_at": "2025-02-22T14:41:00Z",
    "url": "https://example.com/updated_webhook"
  },
  "meta": {
    "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477",
    "curies": [
      {
        "name": "bo",
        "href": "https://app.stora.test{rel}",
        "templated": true,
        "title": "Backoffice"
      },
      {
        "name": "sf",
        "href": "https://acme.stora.test{rel}",
        "templated": true,
        "title": "Storefront"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer Token necessary to use API

Path Parameters

webhook_endpoint_id
string
required

The public ID of the webhook endpoint to retrieve

Body

application/json

Update Webhook Endpoint Request

name
string

The name of the webhook endpoint

description
string | null

Optional description for the webhook endpoint

url
string<uri>

The URL to which the webhook payloads will be delivered

Pattern: ^https://
event_types
enum<string>[]

A list of event types that the webhook endpoint will listen to

Minimum array length: 1
Available options:
contact.created,
contact.updated,
contract.created,
contract.signed,
coupon.created,
coupon.updated,
credit_note.created,
credit_note.updated,
deal.created,
deal.lost,
deal.reopened,
deal.updated,
deal.won,
identity_verification.cancelled,
identity_verification.failed,
identity_verification.processing,
identity_verification.succeeded,
invoice.created,
invoice.finalized,
invoice.marked_uncollectible,
invoice.paid,
invoice.updated,
note.created,
note.updated,
order.completed,
order.created,
order.finalized,
protection_level.created,
protection_level.updated,
subscription.cancelled,
subscription.created,
subscription.ended,
subscription.started,
task.completed,
task.created,
task.reopened,
task.updated,
tenancy.created,
tenancy.started,
unit.available,
unit.created,
unit.deallocated,
unit.occupied,
unit.overlocked,
unit.repossessed,
unit.reserved,
unit.unavailable,
unit.updated,
unit_type.created,
unit_type.updated
metadata
object

Set of key-value pairs for storing additional information on the webhook endpoint. Learn more about metadata.

Response

webhook endpoint updated

Single Webhook Endpoint

endpoint
object

Webhook Endpoint

meta
object