openapi: 3.2.0
info:
  title: Workflow Stage Change Event Webhook Path API
  version: 1.0.0
servers:
- url: https://www.example.com
tags:
- name: Path
paths:
  /example-path:
    post:
      description: Notifies a subscriber when influencers are added to one of their campaigns or moved from one of their campaign’s workflow stages to another.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowStageChangeNotification'
        required: true
      responses:
        '200':
          description: Mavrck successfully delivered the event to Subscriber.
        '401':
          description: Subscriber rejected Mavrck’s request because it isn't authorized. Mavrck will not retry.
        '403':
          description: Subscriber rejected Mavrck’s request because access to a particular resource is forbidden. Mavrck will not retry.
        '404':
          description: Subscriber rejected Mavrck's request because a particular resource could not be found. Mavrck will not retry.
        '405':
          description: Subscriber rejected Mavrck's request because the request method is not known. Mavrck will not retry.
        '500':
          description: Mavrck failed to deliver the event to Subscriber and will retry.
        '502':
          description: Mavrck failed to deliver the event to Subscriber and will retry.
      tags:
      - Path
      summary: Create example path
      x-summary-source: derived
      operationId: postExamplePath
      x-operation-id-source: derived
components:
  schemas:
    Campaign:
      type: object
      description: Details of the campaign in which the workflow stage change occurred.
      properties:
        id:
          type: integer
          description: Unique ID of the campaign in which the workflow stage change occurred.
        instanceId:
          type: integer
          description: Unique ID of the instance to which the campaign belongs.
    WorkflowStageChangeEvent:
      type: object
      description: Details of the workflow stage change.
      properties:
        campaign:
          $ref: '#/components/schemas/Campaign'
        current:
          $ref: '#/components/schemas/WorkflowStage'
        influencer:
          $ref: '#/components/schemas/Influencer'
        previous:
          allOf:
          - $ref: '#/components/schemas/WorkflowStage'
    Influencer:
      type: object
      description: Details of the influencer whose workflow stage changed.
      properties:
        id:
          type: integer
          description: Unique ID of the influencer whose workflow stage changed.
        membershipId:
          type:
          - integer
          - 'null'
          description: Unique ID of the relationship between the influencer and your instance.
    WorkflowStageChangeNotification:
      type: object
      properties:
        event:
          $ref: '#/components/schemas/WorkflowStageChangeEvent'
        subscriberId:
          type: string
          description: Unique ID of your webhook. If your application’s HTTP(S) POST endpoint receives multiple instances’ workflow stage change events, or if multiple applications receive the same instance's events, then this value will vary.
        token:
          type: string
          description: A 16-character alphanumeric string used to authorize requests to your application. Your subscriber's token is accessible in the platform.
    WorkflowStage:
      type: object
      description: Details of a point in a campaign denoting an influencer's progress towards campaign completion.
      properties:
        label:
          type: string
          description: Unique, mutable ID of a workflow stage.
        slug:
          type: string
          description: Unique, immutable ID of a workflow stage in a campaign.