flowdock/openapi/flowdock-push-api-openapi.yml at main · api-evangelist/flowdock · 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
openapi: 3.0.3
info:
  title: Flowdock Push API
  version: "1.0"
  x-status: discontinued
  x-deprecated-by-vendor: true
  x-shutdown-date: "2023-08-15"
  description: |
    The Flowdock Push API was the legacy "post-only" integration surface for
    sending content into a Flow's Team Inbox or Chat using a per-flow API
    token (no user authentication). It was deprecated in favor of the
    Messages endpoint of the REST API and was retired with the rest of
    Flowdock on August 15, 2023.

    Reconstructed from the historical https://github.com/flowdock/api-docs
    repository (docs/push.md, docs/team-inbox.md, docs/chat.md).
servers:
  - url: https://api.flowdock.com
    description: Historical production base URL (offline since 2023-08-15)
tags:
  - name: Team Inbox
    description: Mail-like messages posted into a flow's team inbox.
  - name: Chat
    description: Chat-style messages posted as an external user.
paths:
  /v1/messages/team_inbox/{flow_api_token}:
    post:
      tags: [Team Inbox]
      summary: Push Team Inbox Message
      operationId: pushTeamInbox
      description: Send a mail-like message into a flow's team inbox using its API token.
      parameters:
        - name: flow_api_token
          in: path
          required: true
          schema: { type: string }
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: "#/components/schemas/TeamInboxMessage" }
          application/x-www-form-urlencoded:
            schema: { $ref: "#/components/schemas/TeamInboxMessage" }
      responses:
        "200":
          description: Message accepted.
          content:
            application/json:
              schema: { type: object }
  /v1/messages/chat/{flow_api_token}:
    post:
      tags: [Chat]
      summary: Push Chat Message
      operationId: pushChat
      description: Post a chat message to a flow as an "external user".
      parameters:
        - name: flow_api_token
          in: path
          required: true
          schema: { type: string }
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: "#/components/schemas/ChatMessage" }
          application/x-www-form-urlencoded:
            schema: { $ref: "#/components/schemas/ChatMessage" }
      responses:
        "200":
          description: Message accepted.
          content:
            application/json:
              schema: { type: object }
components:
  schemas:
    TeamInboxMessage:
      type: object
      required: [source, from_address, subject, content]
      properties:
        source:
          type: string
          description: Human readable identifier of the application that uses the Push API.
        from_address:
          type: string
          format: email
        subject: { type: string }
        content:
          type: string
          description: HTML body of the inbox message.
        from_name: { type: string }
        reply_to: { type: string, format: email }
        project: { type: string }
        format: { type: string, enum: [html] }
        link: { type: string, format: uri }
        tags:
          oneOf:
            - type: array
              items: { type: string }
            - type: string
    ChatMessage:
      type: object
      required: [content, external_user_name]
      properties:
        content:
          type: string
          maxLength: 8096
        external_user_name: { type: string }
        tags:
          oneOf:
            - type: array
              items: { type: string }
            - type: string
        message_id:
          type: integer
          description: ID of the parent message when sending a comment.