API status

Webhook Subscriptions

All webhook subscriptions related paths.

get

Get signing keys

Returns a list of signing keys used to verify webhooks.

upvest-client-idstring

required

Tenant Client ID

Format
uuid
Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorizationstring

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Pattern
^Bearer [a-zA-Z0-9\-\._~+/]*=*
Example
"Bearer c2VjcmV0Cg=="
signaturestring

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-inputstring

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-versionstring

Upvest API version (Note: Do not include quotation marks)

Default
"1"
Enum
  • 1
Example
"1"

Responses

Response examples

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"
    }
  ]
}
get

List all webhook subscriptions

Returns a list of all webhook subscriptions.

sortstring

Sort the result by created_at, updated_at, title, url, or enabled.

Default
"created_at"
Enum
  • created_at
  • updated_at
  • title
  • url
  • enabled
orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC
offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format
int32
Min
0
limitint

Use the limit argument to specify the maximum number of items returned.

Format
int32
Default
100
Min
0
Max
1000

Responses