Webhooks

Get All Webhooks

get

Ready to test

Get information about existing webhooks.

Authorizations

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /webhooks HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

200

OK

[
  {
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "eventType": "CUSTOMER_NOTIFICATION",
    "url": "https://client-address.de/e9c1a702ccab"
  },
  {
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "eventType": "DOCUMENT_NOTIFICATION",
    "url": "https://client-address.de/2de0d16efb49",
    "headers": [
      {
        "name": "api-key",
        "value": "secret-api-key"
      }
    ]
  }
]

Create or Update Webhook

post

Ready to test

Create webhook, replacing the webhook for this event type if one already exists. It is possible to create only one webhook per event.

Authorizations

Body

eventTypestring · enumRequiredPossible values:

urlstringRequired

The URL must be HTTPS.

Responses

200

OK

400

Bad Request

application/json

post

HTTPcURLJavaScriptPython

POST /webhooks HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "eventType": "CUSTOMER_NOTIFICATION",
  "url": "https://client-address.de/e9c1a702ccab",
  "headers": [
    {
      "name": "api-key",
      "value": "secret-api-key"
    }
  ]
}

No content

Delete Webhook

delete

Ready to test

Delete webhook with given eventType.

Authorizations

Path parameters

eventTypestringRequired

Event type of webhook.

Responses

200

Webhook deleted

delete

HTTPcURLJavaScriptPython

DELETE /webhooks/{eventType} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

200

Webhook deleted

No content

Get Webhook

get

Ready to test

Get webhook by eventType.

Authorizations

Path parameters

eventTypestringRequired

Event type of webhook.

Responses

200

OK

application/json

404

Not Found

application/json

get

HTTPcURLJavaScriptPython

GET /webhooks/{eventType} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

{
  "createdOn": "2025-05-23T01:02:12.934Z",
  "modifiedOn": "2025-05-23T01:02:12.934Z",
  "eventType": "CUSTOMER_NOTIFICATION",
  "url": "text",
  "headers": [
    {
      "name": "text",
      "value": "text"
    }
  ]
}

Get All Missing Webhooks

get

Ready to test

Get all missing webhooks. This is an auxiliary endpoint to help avoid situations where a notification could be missed.

Authorizations

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /webhooks-missing HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

200

OK

[
  {
    "eventType": "CUSTOMER_NOTIFICATION"
  }
]

Get Undelivered Webhooks

get

Ready to test

Get undelivered webhooks to retry sending them. Undelivered webhooks will be kept in database for 30 days. After this time they may be removed. It is an auxiliary endpoint that helps to find webhooks that have not been delivered.

Authorizations

Query parameters

limitinteger · min: 1Optional

Maximum number of items to return

Default: 20Example: 20

cursorstringOptional

String value used for pagination

startDatestring · date-timeOptional

Beginning of the range. Date time is after this parameter.

Example: 2019-04-12T23:20:50.52Z

endDatestring · date-timeOptional

End of the range. Date time is before this parameter.

Example: 2019-05-12T23:20:50.52Z

eventTypestring · enumOptional

Event type of webhook.

Possible values:

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /undelivered-webhooks HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

200

OK

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "webhook": {
        "createdOn": "2025-05-23T01:02:12.934Z",
        "modifiedOn": "2025-05-23T01:02:12.934Z",
        "eventType": "CUSTOMER_NOTIFICATION",
        "url": "text",
        "headers": [
          {
            "name": "text",
            "value": "text"
          }
        ]
      },
      "body": "text",
      "errorMessage": "text",
      "createdOn": "2025-05-23T01:02:12.934Z",
      "modifiedOn": "2025-05-23T01:02:12.934Z"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Mark Delivered Webhooks

post

Ready to test

Mark the webhook with the specified id and all previous ones as delivered. They will no longer appear in the Get Undelivered Webhooks response.

Authorizations

Body

undeliveredWebhookIdstring · uuidRequired

Id of the newest undelivered webhook to be marked as delivered. All older webhooks will also be marked.

Responses

200

OK

post

HTTPcURLJavaScriptPython

POST /undelivered-webhooks HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "undeliveredWebhookId": "123e4567-e89b-12d3-a456-426614174000"
}

200

OK

No content