Skip to main content
POST
/
webhook
cURL
curl --request POST \
  --url https://api.openformat.tech/v1/webhook \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "url": "https://api.example.com/webhook",
  "events": [
    "transaction"
  ]
}
'
{
  "status": "success",
  "webhook": {
    "id": 123,
    "url": "https://api.example.com/webhook",
    "events": [
      "transaction"
    ],
    "disabled": true,
    "disabled_at": "2024-01-23 01:23:45.55338+00",
    "created_at": "2024-01-23 01:23:45.55338+00"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.openformat.tech/llms.txt

Use this file to discover all available pages before exploring further.

{
  "status": "success",
  "webhook": {
    "id": 123,
    "url": "https://api.example.com/webhook",
    "events": [
      "transaction"
    ],
    "disabled": true,
    "disabled_at": "2024-01-23 01:23:45.55338+00",
    "created_at": "2024-01-23 01:23:45.55338+00"
  }
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
url
string
required

Webhook URL to send the payload, only HTTPS supported

Minimum string length: 1
Example:

"https://api.example.com/webhook"

​
events
string[]

List of events that will trigger the webhook call, if empty all events will be used

Example:
["transaction"]

Response

Created webhook

​
status
enum<string>
required

Successful reponse status

Available options:
success
Example:

"success"

​
webhook
object
required

The webhook data