sift-com/openapi/sift-workflows-api-openapi.yml at main · api-evangelist/sift-com · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
openapi: 3.1.0
info:
  title: Sift Workflows API
  description: |
    Sift Workflows automate decisions on users, orders, sessions, and content based
    on configurable criteria. The Workflows API exposes synchronous workflow
    evaluation through the Events API (`return_workflow_status=true`) and
    administrative endpoints for inspecting workflow status and history.
  version: '205'
  contact:
    name: Sift
    url: https://sift.com
    email: support@sift.com
servers:
  - url: https://api.sift.com/v205
    description: Sift Production API
security:
  - BasicAuth: []
tags:
  - name: Workflows
    description: Inspect Sift Workflow evaluations.
paths:
  /accounts/{account_id}/workflows/runs/{run_id}:
    get:
      summary: Sift Get Workflow Run
      description: Retrieve the result of a single Workflow run by its identifier.
      operationId: getWorkflowRun
      tags: [Workflows]
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: string
        - name: run_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Workflow run details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRun'
  /accounts/{account_id}/users/{user_id}/workflows:
    get:
      summary: Sift List User Workflow Runs
      description: List Workflow runs that have evaluated against the user.
      operationId: listUserWorkflowRuns
      tags: [Workflows]
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: string
        - name: user_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: A list of workflow run summaries.
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
  schemas:
    WorkflowRun:
      type: object
      properties:
        id:
          type: string
        config:
          type: object
        config_version:
          type: integer
        state:
          type: string
        entity:
          type: object
        abuse_types:
          type: array
          items:
            type: string
        history:
          type: array
          items:
            type: object