v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Webhooks

add webhook

Add a new webhook to your Raisely account. By default, this webhook will trigger for events across all campaigns in your Raisely account. Specify a campaignUuid if you'd like to restrict it to one campaign.

For custom components:

RaiselyComponents.api.all('webhooks').post(data = {}, params = {}, headers = {}) => Promise<{result}>

:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper

post/webhooks

Headers

Authorizationstring

A valid HTTP Bearer token, required to access private records.

Request body

Example request

{
  "data": {
    "campaignUuid": "f2a3bcb0-96d8-11e9-8a7b-47a01a90ec39",
    "url": "https://myapp.com/raisely"
  }
}

Response

The created Webhook record

Example response

{
  "data": {
    "uuid": "f89f8270-4a7e-11eb-930b-390f490b0615",
    "createdAt": "2020-12-30T09:11:16.247Z",
    "campaignUuid": "f2a3bcb0-96d8-11e9-8a7b-47a01a90ec39",
    "url": "https://myapp.com/raisely"
  }
}