Update endpoint

1
{
2
  "data": {
3
    "type": "endpoint",
4
    "id": "00000000-0000-0000-0000-000000000000",
5
    "attributes": {
6
      "id": "00000000-0000-0000-0000-000000000000",
7
      "url": "https://mydomain.com/path/to/handler",
8
      "enabled": true,
9
      "description": "lorem",
10
      "event_types": [
11
        {
12
          "type": "v1.project.paused"
13
        }
14
      ],
15
      "custom_headers": {
16
        "Authorization": "Bearer example_token"
17
      },
18
      "created_by": "00000000-0000-0000-0000-000000000000",
19
      "created_at": "4404-02-29T04:24Z"
20
    }
21
  }
22
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "data": {
5
      "type": "object",
6
      "properties": {
7
        "type": {
8
          "type": "string",
9
          "const": "endpoint",
10
          "description": "Resource type."
11
        },
12
        "id": {
13
          "type": "string",
14
          "format": "uuid",
15
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
16
          "description": "Identifier of an endpoint (UUID v7)."
17
        },
18
        "attributes": {
19
          "type": "object",
20
          "properties": {
21
            "id": {
22
              "type": "string",
23
              "format": "uuid",
24
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
25
              "description": "Identifier of an endpoint (UUID v7)."
26
            },
27
            "url": {
28
              "type": "string",
29
              "format": "uri",
30
              "description": "Publicly available URL where to send the events, must use a domain and be resolvable to a non-reserved IP address.",
31
              "example": "https://mydomain.com/path/to/handler"
32
            },
33
            "enabled": {
34
              "type": "boolean",
35
              "description": "Whether the endpoint is enabled or not - disabled endpoints won't emit any events."
36
            },
37
            "description": {
38
              "anyOf": [
39
                {
40
                  "type": "string",
41
                  "maxLength": 512
42
                },
43
                {
44
                  "type": "null"
45
                }
46
              ],
47
              "description": "Optional description for the endpoint."
48
            },
49
            "event_types": {
50
              "minItems": 1,
51
              "type": "array",
52
              "items": {
53
                "type": "object",
54
                "properties": {
55
                  "type": {
56
                    "type": "string",
57
                    "enum": [
58
                      "v1.project.paused",
59
                      "v1.project.created",
60
                      "v1.project.restored",
61
                      "v1.project.transferred",
62
                      "v1.project.removed",
63
                      "v1.project.restarted",
64
                      "v1.project.status.changed",
65
                      "v1.project.backup.started",
66
                      "v1.project.branch.created",
67
                      "v1.project.branch.updated",
68
                      "v1.project.branch.removed",
69
                      "v1.project.secrets.leaked",
70
                      "v1.organization.member.invitation.created",
71
                      "v1.organization.member.invitation.canceled",
72
                      "v1.organization.member.added",
73
                      "v1.organization.member.removed",
74
                      "v1.organization.member.role.assigned",
75
                      "v1.organization.member.role.removed",
76
                      "v1.organization.member.role.updated",
77
                      "v1.organization.billing.plan.upgraded",
78
                      "v1.organization.billing.plan.downgraded",
79
                      "v1.organization.secrets.leaked",
80
                      "*"
81
                    ],
82
                    "description": "Webhook event type."
83
                  }
84
                },
85
                "required": [
86
                  "type"
87
                ]
88
              },
89
              "description": "List of subscribed events for which to receive the webhook event.",
90
              "example": [
91
                {
92
                  "type": "v1.project.paused"
93
                }
94
              ]
95
            },
96
            "custom_headers": {
97
              "description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
98
              "example": {
99
                "Authorization": "Bearer example_token"
100
              },
101
              "type": "object",
102
              "propertyNames": {
103
                "type": "string",
104
                "pattern": "^[a-zA-Z0-9-]+$"
105
              },
106
              "additionalProperties": {
107
                "type": "string"
108
              }
109
            },
110
            "created_by": {
111
              "type": "string",
112
              "format": "uuid",
113
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
114
              "description": "ID of the user who created the endpoint."
115
            },
116
            "created_at": {
117
              "type": "string",
118
              "format": "date-time",
119
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
120
              "description": "Timestamp of endpoint's creation."
121
            }
122
          },
123
          "required": [
124
            "id",
125
            "url",
126
            "enabled",
127
            "description",
128
            "event_types",
129
            "created_by",
130
            "created_at"
131
          ]
132
        }
133
      },
134
      "required": [
135
        "type",
136
        "id",
137
        "attributes"
138
      ]
139
    }
140
  },
141
  "required": [
142
    "data"
143
  ]
144
}