Webhooks

Webhooks

Download Spec

All webhook related paths.

get/auth/verify_keys

Get signing keys

Get 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/webhooks

List all webhooks

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

Response examples

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

post/webhooks

Create a webhook subscription

titlestring

required

Title of the webhook for use on tenant side.

Pattern: ^[a-zA-Z0-9 ()\[\]{}.-]{1,32}$

urlstring

required

The callback URL to be called by the webhook.

Format: url
Max Length: 1000

typearray

What kind of events to be sent by the webhook.

Default: [ "ALL" ]

configobject

Configuration of webhook packages collection.

delaystring

Maximum time of package collection.

Pattern: ^[1-9][0-9]?[sm]$

max_package_sizeint

Maximum package size (bytes)

Min: 100
Max: 1048576

Responses

Request examples

{
  "title": "User webhook",
  "url": "https://tenant.tld/webhooks/users",
  "type": [
    "USER"
  ],
  "config": {
    "delay": "5s",
    "max_package_size": 10240
  }
}

Response examples

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
  }
}

get/webhooks/{webhook_id}

Retrieve a webhook subscription

webhook_idstring

required

Webhook identifier

Format: uuid

Responses

Response examples

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
  }
}

delete/webhooks/{webhook_id}

Delete a webhook subscription

webhook_idstring

required

Webhook identifier

Format: uuid

Responses

Response examples

Request has been processed successfully.

Empty response

patch/webhooks/{webhook_id}

Update a webhook subscription

titlestring

Title of the webhook for use on tenant side.

Pattern: ^[a-zA-Z0-9 ()\[\]{}.-]{1,32}$

urlstring

The callback URL to be called by the webhook.

Format: url
Max Length: 1000

enabledboolean

Enable/disable webhook.

typearray

What kind of events to be sent by the webhook.

Default: [ "ALL" ]

configobject

Configuration of webhook packages collection.

delaystring

Maximum time of package collection.

Pattern: ^[1-9][0-9]?[sm]$

max_package_sizeint

Maximum package size (bytes)

Min: 100
Max: 1048576

Responses

Request examples

{
  "url": "https://tenant.tld/webhooks/users",
  "type": [
    "USER"
  ]
}

Response examples

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
  }
}

post/webhooks/{webhook_id}/test

Test a webhook

webhook_idstring

required

Webhook identifier

Format: uuid

Responses

Response examples

The request has been successfully accepted and will be processed asynchronously.

Empty response

Was this page helpful?