syncano-socket-intercom-users/socket.yml at master · gh3r/syncano-socket-intercom-users · 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
name: intercom-users
version: 0.0.3
description: Syncano-Intercom integration socket for users managment
author:
  name: Marcin Godlewski

config:
  ACCESS_TOKEN:
    description: Intercom Access Token
    required: true

endpoints:
  create:
    description: Creates new user with given object properties
    file: scripts/usersCreate.js
    parameters:
      userInfo:
        type: object
        example: { "email":  "example@email.com" }
  update:
    description: Updates users with specified email with custom attributes
    file: scripts/usersUpdate.js
    parameters:
      email:
        type: string
        example: "example@email.com"
      customAttributes:
        type: object
        example: { "invited_friend": true }
  delete:
    description: Deletes user with specified ID
    file: scripts/usersDelete.js
    parameters:
      id:
        type: string
        example: "58da64160b96689370700d3d"
  list:
    description: Returns list of all users (paged)
    file: scripts/usersList.js
  listBy:
    description: Returns list of users by specified filter parameter
    file: scripts/usersListBy.js
    parameters:
      listParam:
        type: object
        example: { "tag_id": 957050 }
  find:
    description: Searches for user that fulfils search query
    file: scripts/usersFind.js
    parameters:
      searchParam:
        type: object
        example: { "email": "example@email.com" }

classes:
  event_history:
    -
      name: eventName
      type: string
    -
      name: message
      type: object

event_handlers:
  events.intercom-create-new-user:
    file: scripts/usersCreate.js
    parameters:
      userInfo:
        type: string
  events.intercom-user-created:
    file: scripts/saveEvent.js
    parameters:
      eventName:
        type: string
      message:
        type: object
  events.intercom-user-updated:
    file: scripts/saveEvent.js
    parameters:
      eventName:
        type: string
      message:
        type: object
  events.intercom-user-deleted:
    file: scripts/saveEvent.js
    parameters:
      eventName:
        type: string
      message:
        type: object