Webhooks

Create or Update

Partner applications can create or update their webhook urls.

HTTP Request

POST {server_url}/api/v1/webhook

This request must include a valid Api JWT token, please see our documentation

Header Parameter

Parameter	Default
Content-type	application/json
Accept	application/json
Authorization	Bearer {jwttoken}

Request Body

Attribute	Required	Description
webhook	true	Webhook object
↳ url	true	URL for sending Webhooks (must be a valid secure URL)

Example Request

Shell

curl -X POST {server_url}/api/v1/webhook
  -H "Content-type: application/json"
  -H "Authorization: Bearer 34a2sample-api-token"
  -H "Accept: application/json"
  -d '{
    "webhook": {
      "url": "https://www.webhook.com"
    }
  }'

Ruby

RestClient::Request.new(
  :method => :post,
  :url => "{server_url}/api/v1/webhook",
  :headers => {
    "Content-type" => "application/json"
    "Accept" => "application/json"
    "Authorization" => "Bearer 34a2sample-api-token",
  },
  :payload => {
    :webhook => {
      :url => "https://www.webhook.com"
    }
  }
).execute

Example Response

{
  "webhook": {
    "url": "https://www.webhook.com"
  }
}