Register webhook event endpoints

POST

/webhook

curl --request POST \
  --url https://client-api.abi.ai/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "eventList": [ { "name": "questionResolved", "url": "https://partner.example/webhooks/abi/question-resolved" }, { "name": "caseClosed", "url": "https://partner.example/webhooks/abi/case-closed" } ] }'

• Abi Client API

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

Register one or more event names and the HTTPS endpoints that receive them.

object

eventList

required

Event subscriptions to create or update for the authenticated partner.

Array<object>

>= 1 items

object

name

required

Agreed event name to subscribe to. Use the event catalog; only registered events are delivered.

string

>= 1 characters

Example

questionResolved

url

required

HTTPS endpoint that receives this event for the authenticated partner.

string format: uri

Example

https://partner.example/webhooks/abi/question-resolved

Example

{
  "name": "questionResolved",
  "url": "https://partner.example/webhooks/abi/question-resolved"
}

Example

{
  "eventList": [
    {
      "name": "questionResolved",
      "url": "https://partner.example/webhooks/abi/question-resolved"
    },
    {
      "name": "caseClosed",
      "url": "https://partner.example/webhooks/abi/case-closed"
    }
  ]
}

Responses

201

Webhook event endpoints registered.

Media typeapplication/json

Result returned when listing, registering, or removing webhook subscriptions.

object

success

Whether the requested configuration change or lookup succeeded.

boolean

message

Human-readable outcome summary.

string

eventList

Current event subscriptions after the operation

Array<object>

An event subscription returned in the partner’s webhook configuration.

object

name

Registered event name.

string

url

HTTPS endpoint configured for the event.

string format: uri

Example

{
  "success": true,
  "message": "Webhook configuration updated.",
  "eventList": [
    {
      "name": "questionResolved",
      "url": "https://partner.example/webhooks/abi/question-resolved"
    },
    {
      "name": "caseClosed",
      "url": "https://partner.example/webhooks/abi/case-closed"
    }
  ]
}

400

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}