Webhooks
Download SpecAll webhook related paths.
Authentication
oauth-client-credentials
Required Scopes:
webhooks:read
webhooks:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
keys
array[object]
required
List of verification keys
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Examples
{
"keys": [
{
"crv": "P-521",
"kid": "9ed77463-c18e-4794-ab5c-17423f9b801a",
"kty": "EC",
"x": "AcYAf5Ou0UvtehpeRvyhnvvrUQvjI4B3VCxfSmxK4gqKJGxO_jTB-nTdrHbBfmZpwmwYR86DppMg43E579K5MQ54",
"y": "ALkrId77iD0Ye2vBS5bTkLqPH-bo8urTpTXiNc6Ub-VOFbXfJrR0tQ8COvVXXu58BTu8jWV-1mtbjfJpDl3ISbcK"
}
]
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Authentication
oauth-client-credentials
Required Scopes:
webhooks:read
webhooks:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
meta
object (meta)
required
data
array[object (Webhook)]
required
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Examples
{
"data": [
{
"config": {
"delay": "5s",
"max_package_size": 10240
},
"created_at": "2021-07-21T14:10:00.00Z",
"enabled": false,
"id": "a8eb3540-5a84-40f9-b2bb-7f99f282fc5a",
"title": "User webhook",
"type": [
"USER"
],
"updated_at": "2021-07-21T14:10:00.00Z",
"url": "https://tenant.tld/webhooks/users"
}
],
"meta": {
"count": 1,
"limit": 100,
"offset": 0,
"order": "ASC",
"sort": "id",
"total_count": 1
}
}
{
"status": 400,
"type": "bad_request"
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Authentication
oauth-client-credentials
Required Scopes:
webhooks:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
id
string
uuid
required
Webhook unique identifier.
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
title
string
required
Title of the webhook for use on tenant side.
- Max Length
- 100
url
string
url
required
The callback URL to be called by the webhook.
- Max Length
- 1000
enabled
boolean
required
Enable/disable webhook.
type
array[string]
required
What kind of events to be sent by the webhook.
- Default
- ["ALL"]
config
object (config)
required
Configuration of webhook packages collection.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Request Examples
{
"config": {
"delay": "5s",
"max_package_size": 10240
},
"title": "User webhook",
"type": [
"USER"
],
"url": "https://tenant.tld/webhooks/users"
}
Response Examples
{
"config": {
"delay": "5s",
"max_package_size": 10240
},
"created_at": "2021-07-21T14:10:00.00Z",
"enabled": false,
"id": "a8eb3540-5a84-40f9-b2bb-7f99f282fc5a",
"title": "User webhook",
"type": [
"USER"
],
"updated_at": "2021-07-21T14:10:00.00Z",
"url": "https://tenant.tld/webhooks/users"
}
{
"status": 400,
"type": "bad_request"
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Authentication
oauth-client-credentials
Required Scopes:
webhooks:read
webhooks:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
id
string
uuid
required
Webhook unique identifier.
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
title
string
required
Title of the webhook for use on tenant side.
- Max Length
- 100
url
string
url
required
The callback URL to be called by the webhook.
- Max Length
- 1000
enabled
boolean
required
Enable/disable webhook.
type
array[string]
required
What kind of events to be sent by the webhook.
- Default
- ["ALL"]
config
object (config)
required
Configuration of webhook packages collection.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Examples
{
"config": {
"delay": "5s",
"max_package_size": 1024
},
"created_at": "2021-07-21T14:10:00.00Z",
"enabled": true,
"id": "a8eb3540-5a84-40f9-b2bb-7f99f282fc5a",
"title": "User webhook",
"type": [
"USER"
],
"updated_at": "2021-07-21T14:10:00.00Z",
"url": "https://tenant.tld/webhooks/users"
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 404,
"type": "not_found"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Authentication
oauth-client-credentials
Required Scopes:
webhooks:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Examples
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 404,
"type": "not_found"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Authentication
oauth-client-credentials
Required Scopes:
webhooks:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
id
string
uuid
required
Webhook unique identifier.
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
title
string
required
Title of the webhook for use on tenant side.
- Max Length
- 100
url
string
url
required
The callback URL to be called by the webhook.
- Max Length
- 1000
enabled
boolean
required
Enable/disable webhook.
type
array[string]
required
What kind of events to be sent by the webhook.
- Default
- ["ALL"]
config
object (config)
required
Configuration of webhook packages collection.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Request Examples
{
"type": [
"USER"
],
"url": "https://tenant.tld/webhooks/users"
}
Response Examples
{
"config": {
"delay": "5s",
"max_package_size": 10240
},
"created_at": "2021-07-21T14:10:00.00Z",
"enabled": true,
"id": "a8eb3540-5a84-40f9-b2bb-7f99f282fc5a",
"title": "User webhook",
"type": [
"USER"
],
"updated_at": "2021-07-21T14:10:00.00Z",
"url": "https://tenant.tld/webhooks/users"
}
{
"status": 400,
"type": "bad_request"
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 404,
"type": "not_found"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Authentication
oauth-client-credentials
Required Scopes:
webhooks:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Examples
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 404,
"type": "not_found"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Was this page helpful?