objectstack/packages/spec/json-schema/system/Webhook.json at 8ae3d928f9c95dd320e89d8629a52085fc3d2d73 · objectstack-ai/objectstack · 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
{
  "$ref": "#/definitions/Webhook",
  "definitions": {
    "Webhook": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "pattern": "^[a-z_][a-z0-9_]*$"
        },
        "label": {
          "type": "string"
        },
        "object": {
          "type": "string",
          "description": "Object to listen to"
        },
        "triggers": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "create",
              "update",
              "delete",
              "undelete",
              "api"
            ]
          },
          "description": "Events that trigger execution"
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "External URL payload"
        },
        "method": {
          "type": "string",
          "enum": [
            "POST",
            "PUT",
            "GET"
          ],
          "default": "POST"
        },
        "secret": {
          "type": "string",
          "description": "Signing secret (HMAC)"
        },
        "headers": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Custom headers (Auth)"
        },
        "payloadFields": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Fields to include. Empty = All"
        },
        "includeSession": {
          "type": "boolean",
          "default": false,
          "description": "Include user session info"
        },
        "retryCount": {
          "type": "number",
          "default": 3
        },
        "isActive": {
          "type": "boolean",
          "default": true
        }
      },
      "required": [
        "name",
        "object",
        "triggers",
        "url"
      ],
      "additionalProperties": false
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}