Skip to main content
POST
/
v1
/
webhooks
Add Webhook
curl --request POST \
  --url https://api.explorium.ai/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "partner_id": "<string>",
  "webhook_url": "<string>",
  "request_context": null,
  "headers": [
    "<string>"
  ]
}
'
import requests

url = "https://api.explorium.ai/v1/webhooks"

payload = {
"partner_id": "<string>",
"webhook_url": "<string>",
"request_context": None,
"headers": ["<string>"]
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
partner_id: '<string>',
webhook_url: '<string>',
request_context: null,
headers: ['<string>']
})
};

fetch('https://api.explorium.ai/v1/webhooks', 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.explorium.ai/v1/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'partner_id' => '<string>',
'webhook_url' => '<string>',
'request_context' => null,
'headers' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.explorium.ai/v1/webhooks"

payload := strings.NewReader("{\n \"partner_id\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"request_context\": null,\n \"headers\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.explorium.ai/v1/webhooks")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"partner_id\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"request_context\": null,\n \"headers\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.explorium.ai/v1/webhooks")

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

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"partner_id\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"request_context\": null,\n \"headers\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "response_context": {
    "correlation_id": "<string>",
    "time_took_in_seconds": 123
  },
  "created_at": "2023-11-07T05:31:56Z",
  "last_modified_time": "2023-11-07T05:31:56Z",
  "webhook_url": "<string>",
  "webhook_secret": "<string>",
  "headers": [
    "<string>"
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

api_key
string
header
required

Body

application/json
partner_id
string
required
webhook_url
string
required
request_context
Request Context · object | null
Example:

null

headers
string[]
payload_format
enum<string>

An enumeration.

Available options:
json,
stringified_json

Response

Successful Response

This is base response model for all responses in partner service.

response_context
ResponseContext · object
required
created_at
string<date-time>
required
last_modified_time
string<date-time>
required
webhook_url
string
required
webhook_secret
string
required
headers
string[]
payload_format
enum<string>

An enumeration.

Available options:
json,
stringified_json