createWebhook

POST

/api/v1/agents/{agentId}/webhooks

Agent admin. The URL is shown once; deliveries prompt the webhook's session as you.

createWebhook

curl --request POST \
  --url '<base-url>/api/v1/agents/<agentId>/webhooks' \
  --header 'Content-Type: application/json' \
  --cookie 'agenthold_session=<agenthold_session>' \
  --data '
{
  "name": "string",
  "promptTemplate": "string",
  "signingSecret": "string",
  "signatureHeader": "string",
  "enabled": true
}
'

const url = '<base-url>/api/v1/agents/<agentId>/webhooks';
const options = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    cookie: 'agenthold_session=<agenthold_session>'
  },
  body: JSON.stringify({
    name: 'string',
    promptTemplate: 'string',
    signingSecret: 'string',
    signatureHeader: 'string',
    enabled: true
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "<base-url>/api/v1/agents/<agentId>/webhooks"

payload = {
    "name": "string",
    "promptTemplate": "string",
    "signingSecret": "string",
    "signatureHeader": "string",
    "enabled": True
}
headers = {
    "cookie": "agenthold_session=<agenthold_session>",
    "Content-Type": "application/json"
}

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

print(response.text)

Response example

{
  "id": "string",
  "agentId": "string",
  "sessionId": "string",
  "name": "string",
  "promptTemplate": "string",
  "signed": true,
  "signatureHeader": "string",
  "enabled": true,
  "createdBy": {
    "id": "string",
    "email": "string",
    "name": "string",
    "avatarUrl": "string"
  },
  "lastDeliveryAt": "2019-08-24T14:15:22Z",
  "lastError": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "url": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

agentId
string
required

Request body JSON required

name
string
required
maxLength: 100 · minLength: 1
promptTemplate
string
required
{{payload}} marks where the delimited request body goes; otherwise it is appended.

minLength: 1
signingSecret
optional
string
Set to require HMAC-SHA256 signatures; "" removes it; omit to keep.
signatureHeader
optional
string
Header holding the signature. Default X-Hub-Signature-256.
enabled
optional
boolean

Returns

201

Created.

JSON

id
string
required
agentId
string
required
sessionId
string
required
name
string
required
promptTemplate
string
required
signed
boolean
required
signatureHeader
string
required
enabled
boolean
required
createdBy
object
required
- id
  string
  required
- email
  string
  required
- name
  string
  required
- avatarUrl
  string
  required
}
lastError
string
required
createdAt
string
required
format: date-time
url
string
required
The secret delivery URL. Shown once.
lastDeliveryAt
optional
string
format: date-time

400

Error.

JSON

error
string
required

403

Error.

JSON

error
string
required

404

Error.

JSON

error
string
required