All webhook related paths.
/auth/verify_keys
Get list of signing keys used to verify webhooks
upvest-client-id
string
required
Tenant Client ID
authorization
string
required
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
signature
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
signature-input
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
upvest-api-version
string
Upvest API version (Note: Do not include quotation marks)
JWKS signing public keys
{
"keys": [
{
"kid": "9ed77463-c18e-4794-ab5c-17423f9b801a",
"kty": "EC",
"crv": "P-521",
"x": "AcYAf5Ou0UvtehpeRvyhnvvrUQvjI4B3VCxfSmxK4gqKJGxO_jTB-nTdrHbBfmZpwmwYR86DppMg43E579K5MQ54",
"y": "ALkrId77iD0Ye2vBS5bTkLqPH-bo8urTpTXiNc6Ub-VOFbXfJrR0tQ8COvVXXu58BTu8jWV-1mtbjfJpDl3ISbcK"
}
]
}
/webhooks
List all webhooks
sort
string
Sort the result by created_at
, updated_at
, title
, url
, or enabled
.
order
string
Sort order of the result list if the sort
parameter is specified. Use ASC
for ascending or DESC
for descending sort order.
offset
int
Use the offset
argument to specify where in the list of results to start when returning items for a particular query.
limit
int
Use the limit
argument to specify the maximum number of items returned.
An object with a data property that contains an array of webhook subscription objects.
{
"meta": {
"offset": 0,
"limit": 100,
"count": 1,
"total_count": 1,
"sort": "id",
"order": "ASC"
},
"data": [
{
"id": "a8eb3540-5a84-40f9-b2bb-7f99f282fc5a",
"created_at": "2021-07-21T14:10:00.00Z",
"updated_at": "2021-07-21T14:10:00.00Z",
"title": "User webhook",
"url": "https://tenant.tld/webhooks/users",
"type": [
"USER"
],
"enabled": false,
"config": {
"delay": "5s",
"max_package_size": 10240
}
}
]
}
/webhooks
Create a webhook subscription
title
string
required
Title of the webhook for use on tenant side.
url
string
required
The callback URL to be called by the webhook.
type
array
What kind of events to be sent by the webhook.
config
object
Configuration of webhook packages collection.
delay
string
Maximum time of package collection.
max_package_size
int
Maximum package size (bytes)
{
"title": "User webhook",
"url": "https://tenant.tld/webhooks/users",
"type": [
"USER"
],
"config": {
"delay": "5s",
"max_package_size": 10240
}
}
Returns a webhook subscription object if a valid webhook subscription object ID was provided.
{
"id": "a8eb3540-5a84-40f9-b2bb-7f99f282fc5a",
"created_at": "2021-07-21T14:10:00.00Z",
"updated_at": "2021-07-21T14:10:00.00Z",
"title": "User webhook",
"url": "https://tenant.tld/webhooks/users",
"type": [
"USER"
],
"enabled": false,
"config": {
"delay": "5s",
"max_package_size": 10240
}
}
/webhooks/{webhook_id}
Retrieve a webhook subscription
webhook_id
string
required
Webhook identifier
Returns a webhook subscription object if a valid webhook subscription object ID was provided.
{
"id": "a8eb3540-5a84-40f9-b2bb-7f99f282fc5a",
"created_at": "2021-07-21T14:10:00.00Z",
"updated_at": "2021-07-21T14:10:00.00Z",
"title": "User webhook",
"url": "https://tenant.tld/webhooks/users",
"type": [
"USER"
],
"enabled": true,
"config": {
"delay": "5s",
"max_package_size": 1024
}
}
/webhooks/{webhook_id}
Delete a webhook subscription
webhook_id
string
required
Webhook identifier
Request has been processed successfully.
Empty response
/webhooks/{webhook_id}
Update a webhook subscription
title
string
Title of the webhook for use on tenant side.
url
string
The callback URL to be called by the webhook.
enabled
boolean
Enable/disable webhook.
type
array
What kind of events to be sent by the webhook.
config
object
Configuration of webhook packages collection.
delay
string
Maximum time of package collection.
max_package_size
int
Maximum package size (bytes)
{
"url": "https://tenant.tld/webhooks/users",
"type": [
"USER"
]
}
Returns a webhook subscription object if a valid webhook subscription object ID was provided.
{
"id": "a8eb3540-5a84-40f9-b2bb-7f99f282fc5a",
"created_at": "2021-07-21T14:10:00.00Z",
"updated_at": "2021-07-21T14:10:00.00Z",
"title": "User webhook",
"url": "https://tenant.tld/webhooks/users",
"type": [
"USER"
],
"enabled": true,
"config": {
"delay": "5s",
"max_package_size": 10240
}
}
/webhooks/{webhook_id}/test
Test a webhook
webhook_id
string
required
Webhook identifier
The request has been successfully accepted and will be processed asynchronously.
Empty response
Was this page helpful?