1. Home
  2. Docs
  3. Demo: Pizza ‘n Stuff
  4. Implementing Webhooks

Implementing Webhooks

A webhook is a call from the over.ai platform to an outside service, often an API, that sends a request and receives a response.

Implementing webhooks into our agents can be done without writing any code and can expand the capabilities of your agent.

In our pizza demo, implementing webhook would be necessary if we want to send the user an SMS with their order number. In order to do this, we would need to use the Action “send_sms_to_caller”, to add in the parameters SMS_CONTENT and CALLER_NAME, and to paste the webhook URL in the Webook section

To implement the webhook in your agent, perform the following steps in the intents payment.cash and payment.credit:

  • In Action, enter send_sms_to_caller
  • In Parameters, enter the parameters SMS_CONTENT and CALLER_NAME
  • In Webhook, enter the URL http://skills.prod.over.ai/api/general

In this table, you have some of the webhooks available for use in your agent. For more details on webhooks, there is more documentation and sample code available here.

 

Action Name

Parameters Needed

Entities

Webhook

Description

make_call

RECIPIENT_NAME

employees

http://skillsv2.over.ai/api/iamplus/vfd

Calls the recipient

CALLER_NAME

sys.names

make_call

PHONE_NUMBER

sys.phone-number

http://skillsv2.over.ai/api/iamplus/vfd

Calls the number

CALLER_NAME

sys.names

disconnect

http://skillsv2.over.ai/api/iamplus/vfd

Disconnects the call

send_sms

CONTACT_ARRAY

employees

http://skillsv2.over.ai/api/iamplus/videoconference

Sends a text message to chosen contacts

SMS_CONTENT

(no entity – value is the sms content)

send_sms_to_caller

SMS_CONTENT

(no entity – value is the sms content)

http://skills.over.ai/api/general

Sends a pre-written sms to the person who made the call

CALLER_NAME

sys.names

send_note

RECIPIENT_NAME

employees

http://skillsv2.over.ai/api/iamplus/notes

CALLER_NAME

sys.names

Sends Note to Email

MESSAGE_CONTENT

sys.any