Get webhook definition by ID - Fabric

Get webhook definition by ID

cURL

curl --request GET \
  --url https://prod01.oms.fabric.inc/api/v2/webhook/{webhookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'

import requests

url = "https://prod01.oms.fabric.inc/api/v2/webhook/{webhookId}"

headers = {
    "x-site-context": "<x-site-context>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-site-context': '<x-site-context>', Authorization: 'Bearer <token>'}
};

fetch('https://prod01.oms.fabric.inc/api/v2/webhook/{webhookId}', 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://prod01.oms.fabric.inc/api/v2/webhook/{webhookId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-site-context: <x-site-context>"
  ],
]);

$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://prod01.oms.fabric.inc/api/v2/webhook/{webhookId}"

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

req.Header.Add("x-site-context", "<x-site-context>")
    req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))
}

HttpResponse<String> response = Unirest.get("https://prod01.oms.fabric.inc/api/v2/webhook/{webhookId}")
  .header("x-site-context", "<x-site-context>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod01.oms.fabric.inc/api/v2/webhook/{webhookId}")

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

request = Net::HTTP::Get.new(url)
request["x-site-context"] = '<x-site-context>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

HTTP Response Codes

• 200: Success
• 404: Not Found
• 500: Internal Server Error

Example Responses

{
  "target": "http://www.test.com",
  "protocol": "HTTP",
  "source": "OMS",
  "events": "[ORDER_CREATED]",
  "webhookId": "<string>",
  "tenantId": "<string>",
  "targetApiKey": "adfasdWdsaQFSsdf",
  "apiVersion": "<string>",
  "format": "application/json",
  "callbackUrl": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z"
}

{
  "message": "No webhook definition present for the given webhook Id"
}

{
  "message": "Internal Server Error"
}

Authorizations

Authorization

• Type: string (required)
• Header: Authorization
• Description: Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

• x-site-context: string (required) - The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

• webhookId: string (required) - The webhook identifier.

Response Structure

The response for a successful request will include the following fields:

• target: string (required) - Target URL. Example: "http://www.test.com"
• protocol: string (required) - Example: "HTTP"
• source: string (required) - Source of event triggers. Example: "OMS"
• events: string[] (required) - Example: "[ORDER_CREATED]"
• webhookId: string
• tenantId: string
• targetApiKey: string - Required for target service authentication if necessary. Example: "adfasdWdsaQFSsdf"
• format: string - Content-Type of request body while triggering Webhook. Example: "application/json"
• createdDate: string
• updatedDate: string