openapi: 3.2.0
info:
  title: Hostfully Webhooks API
  license:
    name: Apache 2.0
    url: https://www.hostfully.com/
  version: v3.0.1
servers:
- url: https://sandbox-api.hostfully.com
security:
- JWT-Authentication: []
- Agency-API-key: []
tags:
- name: Webhooks
paths:
  /api/v3.3/webhooks:
    get:
      tags:
      - Webhooks
      summary: Get webhooks by affiliate id for a partner integration or agencyUid.
      operationId: findAll
      parameters:
      - name: agencyUid
        in: query
        required: false
        schema:
          type: string
      - name: objectUid
        in: query
        required: false
        schema:
          type: string
      - name: integrationWebhooks
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WebhooksApiListOfResourcesResponseWrapper'
    post:
      tags:
      - Webhooks
      summary: Create webhook
      description: Creates a new webhook for either an agency or integration partner
      operationId: post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookSavingApi3Dto'
        required: true
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WebhooksApiResponseWrapper'
  /api/v3.3/webhooks/{webhookUid}:
    get:
      tags:
      - Webhooks
      summary: Get webhook details
      description: Retrieves details of a specific webhook
      operationId: findByWebhookUid
      parameters:
      - name: webhookUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WebhooksApiResponseWrapper'
    delete:
      tags:
      - Webhooks
      summary: Delete webhook
      description: Removes a webhook configuration
      operationId: delete
      parameters:
      - name: webhookUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
components:
  schemas:
    WebhooksApiListOfResourcesResponseWrapper:
      type: object
      properties:
        webhooks:
          type: array
          items:
            $ref: '#/components/schemas/WebhookApi3ResponseDto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    WebhookApi3ResponseDto:
      type: object
      properties:
        uid:
          type: string
        agencyUid:
          type: string
        webhookType:
          type: string
        eventType:
          type: string
        callbackUrl:
          type: string
        objectUid:
          type: string
        creatorIdentifier:
          type: string
    WebhookSavingApi3Dto:
      required:
      - callbackUrl
      type: object
      properties:
        agencyUid:
          type: string
        webhookType:
          type: string
          enum:
          - POST_FORM
          - POST_JSON
        eventType:
          type: string
          enum:
          - NEW_INQUIRY
          - NEW_BOOKING_REQUEST
          - NEW_BOOKING
          - NEW_BLOCKED_DATES
          - UNIT_CHANGED
          - BOOKING_UPDATED
          - BOOKING_CANCELLED
          - NEW_HOLD
          - NEW_PROPERTY
          - UPDATED_PROPERTY
          - DELETED_PROPERTY
          - ACTIVATED_PROPERTY
          - DEACTIVATED_PROPERTY
          - PROPERTY_AVAILABILITY_UPDATED
          - HOTEL_UPDATED
          - PINCODE_CREATED
          - PINCODE_UPDATED
          - PINCODE_DELETED
          - NEW_INBOX_MESSAGE
          - INBOX_THREAD_UPDATED
          - INTEGRATION_ACTIVATED
          - INTEGRATION_DEACTIVATED
          - CHANNEL_ACTIVATED
          - CHANNEL_DEACTIVATED
          - CUSTOM_DATA_CREATED
          - CUSTOM_DATA_UPDATED
          - CUSTOM_DATA_DELETED
        callbackUrl:
          type: string
        objectUid:
          type: string
        creatorIdentifier:
          type: string
    WebhooksApiResponseWrapper:
      type: object
      properties:
        webhook:
          $ref: '#/components/schemas/WebhookApi3ResponseDto'
  securitySchemes:
    JWT-Authentication:
      type: apiKey
      description: OAuth Access Token
      name: Authorization
      in: header
    Agency-API-key:
      type: apiKey
      description: API Key
      name: X-HOSTFULLY-APIKEY
      in: header
externalDocs:
  description: Hostfully Documentation
  url: https://dev.hostfully.com/v3.0/reference
x-readme:
  explorer-enabled: true
  proxy-enabled: true