Skip to main content
POST
json

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. Available events: Order_Update, New_Sms, Call_Completed, Call_On_Hold, Call_Recording, Call_In_Progress, Call_Ringing. 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