Wufoo Webhooks API

openapi: 3.2.0
info:
  title: Wufoo REST Comments Webhooks API
  description: 'The Wufoo REST API v3 provides programmatic read and write access to a Wufoo

    account: Forms, Fields, Entries, Reports, Widgets, Comments, Users, and

    Webhooks. Every request is per-subdomain and authenticates with the account

    API key over HTTP Basic Auth. Endpoints support `.json` or `.xml` response

    formats by appending the extension to the URL.

    '
  version: '3.0'
  contact:
    name: Wufoo Support
    url: https://help.surveymonkey.com/wufoo/
  license:
    name: Wufoo Terms of Use
    url: https://www.wufoo.com/terms-of-use/
servers:
- url: https://{subdomain}.wufoo.com/api/v3
  description: Wufoo account subdomain
  variables:
    subdomain:
      default: account
      description: Your Wufoo account subdomain.
security:
- basicAuth: []
tags:
- name: Webhooks
  description: Subscribe to and unsubscribe from form submission webhooks.
paths:
  /webhooks/{identifier}.{format}:
    put:
      tags:
      - Webhooks
      summary: Add Form Webhook
      description: Subscribes a URL to receive webhook POSTs when the form is submitted. Up to 10 per form.
      operationId: putFormWebhook
      parameters:
      - $ref: '#/components/parameters/Identifier'
      - $ref: '#/components/parameters/Format'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - url
              properties:
                url:
                  type: string
                  format: uri
                  description: Subscriber endpoint to POST submissions to.
                handshakeKey:
                  type: string
                  description: Shared secret echoed back as `HandshakeKey` in payloads.
                metadata:
                  type: boolean
                  description: When true, include FormStructure and FieldStructure in payload.
      responses:
        '200':
          description: Webhook subscription created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  WebHookPutResult:
                    type: object
                    properties:
                      Hash:
                        type: string
  /webhooks/{identifier}/{hash}.{format}:
    delete:
      tags:
      - Webhooks
      summary: Delete Form Webhook
      description: Unsubscribes a previously created webhook.
      operationId: deleteFormWebhook
      parameters:
      - $ref: '#/components/parameters/Identifier'
      - name: hash
        in: path
        required: true
        description: Webhook hash returned at creation time.
        schema:
          type: string
      - $ref: '#/components/parameters/Format'
      responses:
        '200':
          description: Webhook deleted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  WebHookDeleteResult:
                    type: integer
components:
  parameters:
    Identifier:
      name: identifier
      in: path
      required: true
      description: Form or report hash (preferred) or its title.
      schema:
        type: string
    Format:
      name: format
      in: path
      required: true
      description: Response serialization format.
      schema:
        type: string
        enum:
        - json
        - xml
        default: json
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'HTTP Basic Auth. Use your Wufoo API key as the username and any non-empty

        string as the password. Servers require TLS v1.0 or higher; SSLv3 and lower

        are blocked.

        '