Skip to main content
POST
json

Body

Update_Webhook_Request object

AccountId
string | null

Your Telegent account identifier (prefixed AID-). Max 100 characters.

Maximum string length: 100
WebhookUrl
string | null

The destination URL that Telegent will call when a subscribed event fires. Must be a reachable HTTPS endpoint, max 255 characters.

Maximum string length: 255
Method
string | null

HTTP method used to deliver the webhook payload, typically POST or PUT. Max 10 characters.

Maximum string length: 10
DataFormat
string | null

Payload format for the webhook body, e.g. json or xml. Max 50 characters.

Maximum string length: 50
AuthenticationType
string | null

Authentication scheme used when calling your endpoint. Supported values include Basic, Bearer, or None. Max 10 characters.

Maximum string length: 10
AuthenticationUsername
string | null

Username used when AuthenticationType is Basic. Max 255 characters.

Maximum string length: 255
AuthenticationPassword
string | null

Password used when AuthenticationType is Basic. Max 255 characters.

Maximum string length: 255
AuthenticationToken
string | null

Bearer token or API key used when AuthenticationType is Bearer. Max 255 characters.

Maximum string length: 255
SubscribedEvents
string | null

Comma-separated list of event names this webhook should receive (e.g. Order_Update, New_SMS). Max 255 characters.

Maximum string length: 255
WebhookId
string | null

Identifier of the webhook to update (prefixed WID-). Required to locate the existing record.

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