> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stora.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Disable a Webhook Endpoint

> Disable a webhook endpoint.

Required authorization scope: `public.webhook_endpoint:write`




## OpenAPI

````yaml /2025-09/openapi.json post /2025-09/webhook_endpoints/{webhook_endpoint_id}/disable
openapi: 3.1.1
info:
  title: Stora Public API
  version: 2025-09
  x-build-date: '2026-05-20'
  description: >-
    The Stora Public API gives you programmatic access to your self-storage
    business. Use it to build custom integrations, automate operational
    workflows, and sync data with the tools you already use.
  termsOfService: https://www.stora.co/terms-of-service
  contact:
    name: Stora Support
    url: https://www.stora.co/contact
servers:
  - url: https://public-api.stora.co
    description: Production
security: []
tags:
  - name: Contacts
    description: >-
      Contact is the end user of an operator’s storage business — an individual
      or company that inquires, books, signs agreements, and pays for storage.
  - name: Contract Templates
    description: >-
      Contract Template is a reusable contract blueprint. It contains the
      contract content with fillable fields and variables that Stora can
      pre‑fill at document generation time for a specific contact and tenancy.
  - name: Contracts
    description: >-
      Contract is a document generated from a contract template for a specific
      contact. It tracks the signing lifecycle, moving through statuses such as
      pending, signed, voided, declined, and deleted.
  - name: Coupons
    description: >-
      Coupon is a reusable promotion that reduces the price a contact pays by
      either a percentage or a fixed amount. It can be applied to eligible
      charges such as unit rent or product and may be limited by duration,
      number of uses, or scope.
  - name: Credit Notes
    description: >-
      Credit Note reduces or reverses part or all of a previously issued
      invoice. It references the original invoice and contact, along with the
      specified corrected amounts and taxes.
  - name: Deals
    description: >-
      Deal refers to the collection of information pertaining to a potential
      order including contact, site, unit types, protection.
  - name: Deals / Stages
    description: Deal Stage refers to the stages a deal transitions through.
  - name: Identity Verifications
    description: Identity Verification tracks the process of verifying a contacts identity.
  - name: Images
    description: >-
      Serves images associated with resources such as sites and unit types. The
      endpoint redirects to a temporary pre-signed storage URL where the image
      can be downloaded.
  - name: Invoices
    description: >-
      Invoice is a finalized billing document issued to a contact for their
      storage subscriptions and related charges. It itemizes line items like
      unit rent and protection, applies taxes and discounts, and tracks totals,
      balance due, and status over time.
  - name: Notes
    description: >-
      A note is a text annotation attached to a resource such as a contact,
      unit, subscription, or task. Notes capture observations, reminders, or
      context added by staff or integrations.
  - name: OAuth 2
    description: >-
      The Stora Public API supports two OAuth 2.0 flows. Use **Client
      Credentials** if you are an operator building your own integration. Use
      **Authorization Code** if you are a partner integrating on behalf of an
      operator.
  - name: Orders
    description: >-
      Order captures a contact’s intent to rent storage, including the selected
      site and unit type, move‑in date, pricing, and optional add‑ons like
      protection, products, and services. It tracks status over its lifecycle,
      and may lead to a subscription that bills on a recurring basis.
  - name: Orders / Line Items
    description: >-
      Order Line Items are the individual charges that make up an order. Each
      line item represents a product or service such as unit rent, protection,
      or a one‑off fee, and includes its quantity, unit price, and currency.
  - name: Product Categories
    description: >-
      Product Category groups related products and services into a logical
      classification used for pricing and display.
  - name: Products
    description: >-
      Product represents a sellable item or service offered by the operator. It
      defines attributes such as name, description, pricing model, currency, and
      category, which determine how it’s presented and billed.
  - name: Protection Levels
    description: >-
      Protection Level is an optional add‑on that protects a contact’s stored
      goods up to a chosen coverage amount. It’s priced and billed alongside
      storage, appears as its own product or line item, and follows the same tax
      and discount rules as other charges.
  - name: Sites
    description: >-
      Site is a single physical self‑storage location operated by the operator.
      It’s the container for everything specific to that location: units and
      unit types, pricing and taxes, access control, and reporting.
  - name: Staff
    description: >-
      Staff refers to a member of an organization who works on behalf of the
      operator.
  - name: Subscriptions
    description: >-
      Subscription is an ongoing billing agreement that charges a contact on a
      recurring schedule for storage and related services. It defines the
      billing period and active prices, accrues charges into invoices, and
      reflects proration, discounts, and taxes.
  - name: Tasks
    description: Tasks represent individual pieces of work or actions.
  - name: Tenancies
    description: >-
      Tenancy represents an ongoing storage agreement between a contact and an
      operator, tied to a site and one or more allocated units.
  - name: Timeline / Events
    description: >-
      An event represents a custom timeline entry created by an external
      integration, such as a CRM or messaging app.
  - name: Timeline / Sources
    description: >-
      A source represents the origin of a custom timeline event, such as an
      external CRM, or a custom integration.
  - name: Timeline / Templates
    description: >-
      A template defines the message format for a custom timeline event,
      including the Liquid template and available variables.
  - name: Unit Allocations
    description: >-
      Unit Allocation represents the assignment of a specific unit to a tenancy,
      tracking reservation and access details.
  - name: Unit Types
    description: >-
      Unit Type represents a standardized storage offering at a site, such as
      “50 sq ft indoor” or “20 ft container.” It defines core attributes used
      for pricing and availability, including size, features or access type, and
      display name.
  - name: Units
    description: >-
      Unit is a specific, bookable storage space at a site, for example “Unit
      A‑012” of a given unit type. It carries concrete attributes like
      identifier and status.
  - name: Webhook Endpoints
    description: >-
      Webhook endpoints are used to receive notifications when specific events
      occur in Stora. We will send a `POST` request to the endpoint with the
      event payload.
  - name: Webhooks
    description: >-
      Webhooks are HTTP callbacks that send real-time `POST` requests to your
      configured endpoints when specific events occur in Stora. When an event
      happens (such as an invoice being paid or a credit note being created),
      Stora will immediately send a webhook notification to all endpoints
      subscribed to that event type.
externalDocs:
  description: Stora Public API documentation website
  url: https://docs.stora.co/2025-09/
paths:
  /2025-09/webhook_endpoints/{webhook_endpoint_id}/disable:
    parameters:
      - name: webhook_endpoint_id
        in: path
        description: The ID of the webhook endpoint to disable
        required: true
        schema:
          type: string
    post:
      tags:
        - Webhook Endpoints
      summary: Disable a Webhook Endpoint
      description: |
        Disable a webhook endpoint.

        Required authorization scope: `public.webhook_endpoint:write`
      operationId: webhook_endpoint_disable
      responses:
        '200':
          description: disable webhook endpoint
          content:
            application/json:
              examples:
                default:
                  value:
                    endpoint:
                      id: we_195h6kfm9ro15lof
                      api_version: 2025-09
                      created_at: '2025-02-22T14:41:00Z'
                      creator:
                        id: staff_06778802edebb94d
                      description: Test webhook endpoint
                      disabled_at: '2025-02-22T14:41:00Z'
                      event_types:
                        - credit_note.created
                      metadata: {}
                      name: My Webhook
                      secret: null
                      status: disabled
                      updated_at: '2025-02-22T14:41:00Z'
                      url: https://example.com/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
                  summary: disable webhook endpoint
              schema:
                $ref: '#/components/schemas/webhook_endpoint_single'
        '403':
          description: webhook endpoint managed by authorized application
          content:
            application/json:
              examples:
                default:
                  value:
                    error:
                      code: forbidden
                      details: []
                      links:
                        - kind: open_api
                          name: OpenAPI specification
                          url: https://docs.stora.test/2025-09/openapi.json
                        - kind: documentation
                          name: Errors
                          url: https://docs.stora.test/2025-09/guides/errors
                      message: >-
                        This webhook endpoint is managed by Zapier and cannot be
                        modified through this access token
                      request_id: 01563646-58c1-4607-8fe0-cae3e92c4477
                      type: invalid_request_error
                  summary: webhook endpoint managed by authorized application
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: webhook endpoint not found
          content:
            application/json:
              examples:
                default:
                  value:
                    error:
                      code: resource_not_found
                      details: []
                      links:
                        - kind: open_api
                          name: OpenAPI specification
                          url: https://docs.stora.test/2025-09/openapi.json
                        - kind: documentation
                          name: Errors
                          url: https://docs.stora.test/2025-09/guides/errors
                      message: The Webhook/Endpoint was not found.
                      request_id: 01563646-58c1-4607-8fe0-cae3e92c4477
                      type: invalid_request_error
                  summary: webhook endpoint not found
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - Bearer:
            - public.webhook_endpoint:write
        - OAuth2:
            - public.webhook_endpoint:write
components:
  schemas:
    webhook_endpoint_single:
      type: object
      description: Single Webhook Endpoint
      additionalProperties: false
      properties:
        endpoint:
          $ref: '#/components/schemas/WebhookEndpoint'
        meta:
          $ref: '#/components/schemas/Meta'
    Error:
      type: object
      description: Error
      additionalProperties: false
      properties:
        error:
          type: object
          additionalProperties: false
          properties:
            code:
              type: string
              description: Short code that represents the error.
            type:
              enum:
                - invalid_request_error
                - api_error
              description: Type of error returned.
              type: string
            message:
              type: string
              description: >-
                Human-readable message providing brief information about the
                error.
            links:
              type: array
              description: Link(s) to Stora developer resources
              items:
                type: object
                properties:
                  name:
                    type: string
                    description: Name of Stora documentation
                  url:
                    type: string
                    format: uri
                    description: URL to Stora documentation
                  kind:
                    type: string
                    description: Kind of Stora documentation
            details:
              type: array
              description: Array of error details.
              items:
                $ref: '#/components/schemas/ErrorDetail'
            request_id:
              type: string
              description: Unique request identifier.
    WebhookEndpoint:
      type: object
      description: Webhook Endpoint
      additionalProperties: false
      properties:
        id:
          type: string
          description: Unique identifier for the webhook endpoint.
        name:
          type: string
          description: Name of the webhook endpoint.
        description:
          type:
            - string
            - 'null'
          description: Optional description of the webhook endpoint.
        url:
          type: string
          format: uri
          description: The HTTPS URL where webhook events will be sent.
        api_version:
          type: string
          description: The API version to use when sending webhook payloads.
          enum:
            - 2025-09
        event_types:
          type: array
          description: List of event types this endpoint is subscribed to.
          items:
            type: string
            enum:
              - 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:
          $ref: '#/components/schemas/Metadata'
        secret:
          type:
            - string
            - 'null'
          description: >-
            Secret used to sign webhook payloads for verification. Exposed only
            on creation, otherwise returns `null`.
        status:
          type: string
          description: Status of the webhook endpoint.
          enum:
            - disabled
            - enabled
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the webhook endpoint.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the webhook endpoint.
        disabled_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Date and time when the webhook endpoint was disabled, `null` if
            enabled.
        creator:
          description: >-
            Creator of the webhook endpoint. Can be Staff, Access Token, or
            Application.
          oneOf:
            - $ref: '#/components/schemas/Staff'
            - $ref: '#/components/schemas/AccessToken'
            - $ref: '#/components/schemas/Application'
            - type: 'null'
    Meta:
      type: object
      properties:
        request_id:
          type: string
          description: Unique request identifier.
        curies:
          type: array
          description: CURIE definitions for resolving namespaced link relations.
          items:
            $ref: '#/components/schemas/Curie'
    ErrorDetail:
      type: object
      description: ErrorDetail
      additionalProperties: false
      properties:
        message:
          type: string
          description: >-
            Human-readable message providing detailed information about the
            error.
        pointer:
          type:
            - string
            - 'null'
          description: >
            Points to the request field that caused the error:

            - String starting with '/': Exact path of the problematic field.

            - String starting without '/': General hint, cannot pinpoint exact
            field.

            - null: Error cannot be mapped to any specific field.
    Metadata:
      type: object
      description: >-
        Set of key-value pairs for storing additional information. [Learn more
        about metadata.](https://docs.stora.co/2025-09/guides/metadata)
      additionalProperties:
        type: string
    Staff:
      type: object
      description: Staff
      additionalProperties: false
      properties:
        id:
          type: string
          pattern: ^staff_
          description: Unique identifier for the staff member.
        name:
          type: string
        email:
          type: string
          format: email
          description: Email address of the staff member.
        created_at:
          type: string
          format: date-time
          description: Creation date and time of the staff.
        updated_at:
          type: string
          format: date-time
          description: Last update date and time of the staff.
    AccessToken:
      type: object
      description: Access Token
      additionalProperties: false
      properties:
        id:
          type: string
          pattern: ^tok_
          description: Unique identifier for the access token.
        name:
          type: string
          description: Name of the access token.
    Application:
      type: object
      description: Application
      additionalProperties: false
      properties:
        id:
          type: string
          pattern: ^app_
          description: Unique identifier for the application.
        name:
          type: string
          description: Name of the application.
    Curie:
      type: object
      description: CURIE definition for resolving namespaced link relations.
      additionalProperties: false
      properties:
        name:
          type: string
          description: CURIE prefix name
          enum:
            - bo
            - sf
        href:
          type: string
          description: URI template for resolving the CURIE.
        templated:
          type: boolean
          description: Whether the href is a URI template.
        title:
          type: string
          description: Human-readable title.
  securitySchemes:
    Bearer:
      description: Bearer Token necessary to use API
      type: http
      scheme: bearer
      bearerFormat: token
    OAuth2:
      type: oauth2
      description: OAuth 2 authentication
      flows:
        clientCredentials:
          tokenUrl: /oauth2/token
          scopes:
            public.access_token:read: Access Token (Read)
            public.application:read: Application (Read)
            public.contact:read: Contact (Read)
            public.contact:write: Contact (Write)
            public.contract:read: Contract (Read)
            public.contract_template:read: Contract Template (Read)
            public.coupon:read: Coupon (Read)
            public.credit_note:read: Credit Note (Read)
            public.deal:read: Deal (Read)
            public.deal:write: Deal (Write)
            public.deal_stage:read: Deal Stage (Read)
            public.identity_verification:read: Identity Verification (Read)
            public.invoice:read: Invoice (Read)
            public.note:read: Note (Read)
            public.note:write: Note (Write)
            public.order:read: Order (Read)
            public.order:write: Order (Write)
            public.product:read: Product (Read)
            public.product:write: Product (Write)
            public.product_category:read: Product Category (Read)
            public.protection_level:read: Protection Level (Read)
            public.protection_level:write: Protection Level (Write)
            public.site:read: Site (Read)
            public.staff:read: Staff (Read)
            public.subscription:read: Subscription (Read)
            public.task:read: Task (Read)
            public.task:write: Task (Write)
            public.tenancy:read: Tenancy (Read)
            public.timeline_event:read: Timeline Event (Read)
            public.timeline_event:write: Timeline Event (Write)
            public.timeline_source:read: Timeline Source (Read)
            public.timeline_template:read: Timeline Template (Read)
            public.unit:read: Unit (Read)
            public.unit:write: Unit (Write)
            public.unit_allocation:read: Unit Allocation (Read)
            public.unit_type:read: Unit Type (Read)
            public.unit_type:write: Unit Type (Write)
            public.webhook_endpoint:read: Webhook Endpoint (Read)
            public.webhook_endpoint:write: Webhook Endpoint (Write)
        authorizationCode:
          authorizationUrl: https://app.stora.co/oauth2/authorize
          tokenUrl: /oauth2/token
          scopes:
            public.access_token:read: Access Token (Read)
            public.application:read: Application (Read)
            public.contact:read: Contact (Read)
            public.contact:write: Contact (Write)
            public.contract:read: Contract (Read)
            public.contract_template:read: Contract Template (Read)
            public.coupon:read: Coupon (Read)
            public.credit_note:read: Credit Note (Read)
            public.deal:read: Deal (Read)
            public.deal:write: Deal (Write)
            public.deal_stage:read: Deal Stage (Read)
            public.identity_verification:read: Identity Verification (Read)
            public.invoice:read: Invoice (Read)
            public.note:read: Note (Read)
            public.note:write: Note (Write)
            public.order:read: Order (Read)
            public.order:write: Order (Write)
            public.product:read: Product (Read)
            public.product:write: Product (Write)
            public.product_category:read: Product Category (Read)
            public.protection_level:read: Protection Level (Read)
            public.protection_level:write: Protection Level (Write)
            public.site:read: Site (Read)
            public.staff:read: Staff (Read)
            public.subscription:read: Subscription (Read)
            public.task:read: Task (Read)
            public.task:write: Task (Write)
            public.tenancy:read: Tenancy (Read)
            public.timeline_event:read: Timeline Event (Read)
            public.timeline_event:write: Timeline Event (Write)
            public.timeline_source:read: Timeline Source (Read)
            public.timeline_template:read: Timeline Template (Read)
            public.unit:read: Unit (Read)
            public.unit:write: Unit (Write)
            public.unit_allocation:read: Unit Allocation (Read)
            public.unit_type:read: Unit Type (Read)
            public.unit_type:write: Unit Type (Write)
            public.webhook_endpoint:read: Webhook Endpoint (Read)
            public.webhook_endpoint:write: Webhook Endpoint (Write)

````