Skip to content
QeychainQeychain API

Create Webhook

POST
/api/v1/webhooks
curl --request POST \
  --url https://api.qeychain.xyz/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --data '{ "url": "example", "events": [ "example" ], "addresses_filter": [ "example" ], "description": "example", "headers": { "additionalProperty": "example" } }'

Register a new webhook endpoint.

The signing secret is returned only once - store it securely!

Available event types:

  • transaction.new: New transaction detected
  • lot.created: New tax lot created
  • lot.consumed: Lot partially/fully consumed
  • wash_sale.detected: Wash sale triggered
  • price.alert: Price threshold crossed
  • calculation.complete: Background calculation finished

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CreateWebhookRequest

Request to create a new webhook.

object
url
required
Url

Webhook endpoint URL

string
<= 2048 characters
events
required
Events

Event types to subscribe to

Array<string>
>= 1 items
addresses_filter
Any of:
Array<string>
description
Any of:
string
headers
Any of:
object
key
additional properties
string
Examplegenerated
{
  "url": "example",
  "events": [
    "example"
  ],
  "addresses_filter": [
    "example"
  ],
  "description": "example",
  "headers": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Create Webhook Api V1 Webhooks Post
object
key
additional properties
any
Examplegenerated
{}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}