Skip to content

Administrator Guide

Rowan Seymour edited this page Mar 3, 2015 · 1 revision

RapidPro Integration

To notify ChatPro when a new chat message has been received, add the following webhook to your group chat flow:

  • URL: /api/v1/message/new/
  • Method: POST
  • Query parameters:
    • contact: the UUID of the contact that received the message
    • text: the text of the message
    • group: the UUID of the contact group that the message was routed to
    • token: your organization's ChatPro secret token

For example:

http://chat.rapidpro.io/api/v1/message/new/?contact=@contact.uuid&text=@step.value&group=bef530c4-5d84-4c1e-ad82-7a563866446c&token=1234567890

To notify ChatPro when a new chat contact has been registered, add the following webhook to your registration flow:

  • URL: /api/v1/contact/new/
  • Method: POST
  • Query parameters:
    • contact: the UUID of the contact that received the message
    • group: the UUID of the contact group that contact has joined
    • token: your organization's ChatPro secret token

For example:

http://chat.rapidpro.io/api/v1/contact/new/?contact=@contact.uuid&group=bef530c4-5d84-4c1e-ad82-7a563866446c&token=1234567890

To notify ChatPro when a contact has left group chat

  • URL: /api/v1/contact/del/
  • Method: POST
  • Query parameters:
    • contact: the UUID of the contact that received the message
    • token: your organization's ChatPro secret token

For example:

http://chat.rapidpro.io/api/v1/message/new/?contact=@contact.uuid&token=1234567890

Clone this wiki locally