openapi: 3.2.0
info:
  title: Data sent by webhooks Panelists API
  version: 1.0.0
  license:
    name: Forsta
    identifier: Forsta
    url: http://forsta.com
  description: 'Data sent by webhooks


    # Signed payload


    During creation of a webhook there is an option to send payload signed.'
servers:
- url: CLIENT SERVER URL
  description: Panel Management servers
tags:
- name: Panelists
  description: Endpoints related to panelists
paths:
  /webhookPanelistEvents:
    post:
      operationId: webhookPanelistEvents
      security:
      - signedPayloadAuth: []
      summary: Payload format for events about panelists
      tags:
      - Panelists
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  identifier:
                    type: string
                    description: Request identifier
                  timestamp:
                    type: integer
                    description: Timestamp of the request
                  panel_id:
                    type: integer
                    description: Panel ID related to the event
                  event:
                    type: string
                    description: Event name, possible options 'panelist-created', 'panelist-updated', 'panelist-deleted', 'panelist-optin'
                  event_id:
                    type: integer
                    description: Event ID
                  data:
                    type: array
                    description: Data only present for events 'panelist-created' and 'panelist-updated'
                    items:
                      type: object
                      properties:
                        label:
                          type: string
                          description: Question or panelist's property
                        answer:
                          type: string
                          description: Value provided by a panelist
              example:
              - identifier: req123
                timestamp: 1724359389
                panel_id: 1
                event: panelist-updated
                event_id: 123
                data:
                - label: email
                  answer: test@forsta.com
                - label: emailok
                  answer: 'yes'
components:
  securitySchemes:
    signedPayloadAuth:
      type: apiKey
      in: header
      name: X-KP-Webhook-Signature
      description: 'Security scheme for signed payloads.

        Include a signature of the payload in the "X-KP-Webhook-Signature" header.

        '
x-tagGroups:
- name: Data sent by webhooks
  tags:
  - Panelists
  - Survey Activity
  - Survey Invitation