Skip to main content
POST
/
v1.0
/
webhook
/
create
json
{
  "AccountId": "AID-1234567",
  "WebhookUrl": "https://api.example.com/telegent/events",
  "Method": "POST",
  "DataFormat": "json",
  "AuthenticationType": "Basic",
  "AuthenticationUsername": "webhook_user",
  "AuthenticationPassword": "s3cureP@ss",
  "AuthenticationToken": "",
  "SubscribedEvents": "Order_Update"
}
{
  "AccountId": "<string>",
  "WebhookUrl": "<string>",
  "Method": "<string>",
  "DataFormat": "<string>",
  "AuthenticationType": "<string>",
  "AuthenticationUsername": "<string>",
  "AuthenticationPassword": "<string>",
  "AuthenticationToken": "<string>",
  "SubscribedEvents": "<string>",
  "WebhookId": "<string>",
  "Active": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.telegent.com/llms.txt

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

Body

Webhooks object

​
AccountId
string | null

Your Telegent account identifier in the format AID-XXXXXXX. Max 100 characters.

Maximum string length: 100
​
WebhookUrl
string | null

The HTTPS URL Telegent will call when subscribed events fire. Max 255 characters.

Maximum string length: 255
​
Method
string | null

HTTP method Telegent should use when invoking the webhook, typically POST or PUT. Max 10 characters.

Maximum string length: 10
​
DataFormat
string | null

Payload format sent to your endpoint, such as json or xml. Max 50 characters.

Maximum string length: 50
​
AuthenticationType
string | null

Authentication scheme used when calling the webhook: None, Basic, or Token. Max 10 characters.

Maximum string length: 10
​
AuthenticationUsername
string | null

Username for Basic authentication. Required when AuthenticationType is Basic. Max 255 characters.

Maximum string length: 255
​
AuthenticationPassword
string | null

Password for Basic authentication. Required when AuthenticationType is Basic. Max 255 characters.

Maximum string length: 255
​
AuthenticationToken
string | null

Bearer token sent in the Authorization header. Required when AuthenticationType is Token. Max 255 characters.

Maximum string length: 255
​
SubscribedEvents
string | null

Comma-separated list of events to subscribe to (e.g. Order_Update, Message_Status). Max 255 characters.

Maximum string length: 255

Response

Success

​
AccountId
string | null
Maximum string length: 100
​
WebhookUrl
string | null
Maximum string length: 255
​
Method
string | null
Maximum string length: 10
​
DataFormat
string | null
Maximum string length: 50
​
AuthenticationType
string | null
Maximum string length: 10
​
AuthenticationUsername
string | null
Maximum string length: 255
​
AuthenticationPassword
string | null
Maximum string length: 255
​
AuthenticationToken
string | null
Maximum string length: 255
​
SubscribedEvents
string | null
Maximum string length: 255
​
WebhookId
string | null
​
Active
boolean | null