Skip to main content
GET
/
webhook
/
{id}
cURL
curl --request GET \
  --url https://api.openformat.tech/v1/webhook/{id} \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.openformat.tech/v1/webhook/{id}"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.openformat.tech/v1/webhook/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.openformat.tech/v1/webhook/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.openformat.tech/v1/webhook/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.openformat.tech/v1/webhook/{id}")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.openformat.tech/v1/webhook/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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"
  }
}

{
  "success": false,
  "error": {
    "issues": [
      {
        "validation": "regex",
        "code": "invalid_string",
        "message": "Invalid",
        "path": [
          "id"
        ]
      }
    ],
    "name": "ZodError"
  }
}

{
  "status": "failed",
  "error": "Webhook not found"
}

{
  "status": "failed",
  "error": "Database operation failed"
}

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

{
  "success": false,
  "error": {
    "issues": [
      {
        "validation": "regex",
        "code": "invalid_string",
        "message": "Invalid",
        "path": [
          "id"
        ]
      }
    ],
    "name": "ZodError"
  }
}

{
  "status": "failed",
  "error": "Webhook not found"
}

{
  "status": "failed",
  "error": "Database operation failed"
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Webhook id

Pattern: ^\d+$
Example:

"123"

Response

Webhook data

​
status
enum<string>
required

Successful reponse status

Available options:
success
Example:

"success"

​
webhook
object
required

The webhook data