Skip to main content
GET
/
hooks
/
{hook_id}
Get Hook Information
curl --request GET \
  --url https://api.xplenty.com/{account_id}/api/hooks/{hook_id} \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>'
{
  "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>"
}

Documentation Index

Fetch the complete documentation index at: https://www.integrate.io/docs/llms.txt

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

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

Path Parameters

​
hook_id
integer
required

Response

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

Successful response

​
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>
Last modified on May 22, 2026