You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- description: The Xero Webhooks API exposes event notifications relating to entities in the Xero Public API and can be used for a variety of purposes.
12
+
- description: The Xero Webhooks API exposes event notifications relating to entities in the Xero Public API and can be used for a variety of purposes
13
13
url: https://api.xero.com
14
+
security: []
14
15
webhooks:
15
16
invoices:
16
17
post:
@@ -97,17 +98,27 @@ components:
97
98
description: The date and time that event occurred (UTC time)
98
99
eventType:
99
100
type: string
100
-
description: The type of event of that occurred (e.g. Update)
101
+
description: The type of event of that occurred (e.g. UPDATE)
102
+
enum:
103
+
- CREATE
104
+
- UPDATE
101
105
eventCategory:
102
106
type: string
103
-
description: The category of event that occurred (e.g. CONTACT). You will only retrieve events from categories that your webhook is subscribed to.
107
+
description: The category of event that occurred (e.g. CONTACT). You will only retrieve events from categories that your webhook is subscribed to
108
+
enum:
109
+
- CONTACT
110
+
- INVOICE
111
+
- SUBSCRIPTION
104
112
tenantId:
105
113
type: string
106
114
format: uuid
107
115
description: The ID of the tenant that the event happened in relation to (OrganisationID or ApplicationID)
108
116
tenantType:
109
117
type: string
110
118
description: The type of tenant, depending on the type of event it will be one of ORGANISATION (for Contact or Invoice events), or APPLICATION (for Subscription events)
119
+
enum:
120
+
- ORGANISATION
121
+
- APPLICATION
111
122
required:
112
123
- resourceUrl
113
124
- resourceId
@@ -116,20 +127,20 @@ components:
116
127
- eventCategory
117
128
- tenantId
118
129
- tenantType
119
-
description: A list of events that have occurred.
130
+
description: A list of events that have occurred
120
131
lastEventSequence:
121
132
type: integer
122
133
minimum: 1
123
134
maximum: 2147483647
124
-
description: The sequence number of the last event in the list.
135
+
description: The sequence number of the last event in the list
125
136
firstEventSequence:
126
137
type: integer
127
138
minimum: 1
128
139
maximum: 2147483647
129
-
description: The sequence number of the first event in the list.
140
+
description: The sequence number of the first event in the list
130
141
entropy:
131
142
type: string
132
-
description: A random string used for security or validation purposes.
143
+
description: A random string used for security or validation purposes
133
144
responses:
134
145
401InvalidWebhookData:
135
146
description: Return a 401 status to indicate that the webhook subscription failed
0 commit comments