Create Hook

Creates a new webhook for event notifications.

POST /hooks

Create Hook

cURL

curl --request POST \
  --url https://api.xplenty.com/{account_id}/api/hooks \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "name": "<string>",
  "settings": {},
  "events": [
    "<string>"
  ],
  "active": true
}
'

import requests

url = "https://api.xplenty.com/{account_id}/api/hooks"

payload = {
    "type": "<string>",
    "name": "<string>",
    "settings": {},
    "events": ["<string>"],
    "active": True
}
headers = {
    "Accept": "<accept>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Accept: '<accept>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: '<string>',
    name: '<string>',
    settings: {},
    events: ['<string>'],
    active: true
  })
};

fetch('https://api.xplenty.com/{account_id}/api/hooks', 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.xplenty.com/{account_id}/api/hooks",
  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([
    'type' => '<string>',
    'name' => '<string>',
    'settings' => [
        
    ],
    'events' => [
        '<string>'
    ],
    'active' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Accept: <accept>",
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$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.xplenty.com/{account_id}/api/hooks"

	payload := strings.NewReader("{\n  \"type\": \"<string>\",\n  \"name\": \"<string>\",\n  \"settings\": {},\n  \"events\": [\n    \"<string>\"\n  ],\n  \"active\": true\n}")

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

	req.Header.Add("Accept", "<accept>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.xplenty.com/{account_id}/api/hooks")
  .header("Accept", "<accept>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"<string>\",\n  \"name\": \"<string>\",\n  \"settings\": {},\n  \"events\": [\n    \"<string>\"\n  ],\n  \"active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.xplenty.com/{account_id}/api/hooks")

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

request = Net::HTTP::Post.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"<string>\",\n  \"name\": \"<string>\",\n  \"settings\": {},\n  \"events\": [\n    \"<string>\"\n  ],\n  \"active\": true\n}"

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

201

{
  "id": 123,
  "type": "<string>",
  "name": "<string>",
  "active": true,
  "settings": {},
  "events": [
    "<string>"
  ],
  "salt": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>"
}

Authorizations

Authorization · string · header · required

Enter your API key as the username. Leave the password field blank. Example: curl -u YOUR_API_KEY: https://api.xplenty.com/...

Headers

Accept · string · default: application/vnd.xplenty+json; version=2 · required

API version header — required on all requests

Body

application/json

type · string · required

name · string · required

settings · object · required

Hook-type-specific settings (e.g., URL for web hooks)

events · string[] · required

Events to subscribe to

active · boolean · default: true

Response

201 - application/vnd.xplenty+json; version=2

Hook created

id · integer

type · string

name · string

active · boolean

settings · object

events · string[]

salt · string

created_at · string<date-time>

updated_at · string<date-time>

url · string<uri>