Update/Webhook

Overview

Occasionally you'll want to update, add, remove, and retrieve callback URLs for receiving webhooks. These are the URLs we will send your webhooks to when data is updated. As you may want to be able to update a development server as well as a production server we allow up to 3 URLs to be set at any one time.

Configuration

This endpoint is not used for and will not function before initial configuration. For this endpoint you will need to be authenticated and will need to be made from an already verified server.

GET

https://ad1.replypro.io/api/public/update/webhook

Use this URL to request a a list of your verified callback urls:

The return will look like this:

{
  "results": [
    "https://development/callback_example",
    "https://staging/callback_example",
    "https://production/callback_example"
  ]
}

POST/PUT/DELETE

The following parameters are to be submitted as needed with each POST, PUT, and DELETE request.

Parameters	Description
existing_callback_url	A callback URL currently in use to be updated or removed. This parameter is required when making a PUT or a DELETE request.
new_callback_url	A callback URL to be added. This parameter is required when making a POST or a PUT request.

Here are examples of each request.

{
  "new_callback_url": "https://development:port/callback_example"
}

{
  "new_callback_url": "https://development:port/new_callback_example",
  "existing_callback_url": "https://development:port/callback_example"
}

{
  "existing_callback_url": "https://development:port/callback_example"
}