Webhook

Webhook Properties

Field	Description
active	Whether events should be sent to this webhook. Can be either trueor false. Defaults to true.
created_at	When a Webhook was created on the Malomo Platform.
id	Unique identifier per Webhook.
topic	Event that triggers a webhook.
updated_at	When a Webhook was last updated.
url	URL webhook events should be sent to.

Create a Webhook

POST https://api.gomalomo.com/webhooks

Request Body

Name	Type	Description
active	boolean	Whether to send events to a webhook. Defaults to true.
secret	string	Key used to sign webhook events.
topic	string	Event that triggers a webhook.
url	string	URL to send webhook events to.

200

{
  "active": true,
  "created_at": "2019-01-30T13:30:00Z",
  "id": "be005f40-f068-4ca6-a936-f11b2f902ffc",
  "topic": "events:created",
  "updated_at": "2019-01-30T13:30:00Z",
  "url": "https://myapp.com/webhooks"
}

Retrieve a Webhook

GET https://api.gomalomo.com/webhooks/:id

Path Parameters

Name	Type	Description
id	string	Unique identifier of the desired Webhook.

200

{
  "active": true,
  "created_at": "2019-01-30T13:30:00Z",
  "id": "be005f40-f068-4ca6-a936-f11b2f902ffc",
  "topic": "events:created",
  "updated_at": "2019-01-30T13:30:00Z",
  "url": "https://myapp.com/webhooks"
}

Retrieve a List of Webhooks

GET https://api.gomalomo.com/webhooks

Query Parameters

Name	Type	Description
prev	string	Retrieve webhooks before a given cursor.
next	string	Retrieve webhooks after a given cursor.

200

[
  {
    "active": true,
    "created_at": "2019-01-30T13:30:00Z",
    "id": "be005f40-f068-4ca6-a936-f11b2f902ffc",
    "topic": "events:created",
    "updated_at": "2019-01-30T13:30:00Z",
    "url": "https://myapp.com/webhooks"
  }
]

Update a Webhook

PUT https://api.gomalomo.com/webhooks/:id

Path Parameters

Name	Type	Description
id	string	Unique identifier of the Webhook to update.

Request Body

Name	Type	Description
active	boolean	Whether to send events to a webhook.
url	string	URL to send webhook events to.

200

{
  "active": true,
  "created_at": "2019-01-30T13:30:00Z",
  "id": "be005f40-f068-4ca6-a936-f11b2f902ffc",
  "topic": "events:created",
  "updated_at": "2019-01-30T13:30:00Z",
  "url": "https://myapp.com/webhooks"
}

Delete a Webhook

DELETE https://api.gomalomo.com/webhooks/:id

Path Parameters

Name	Type	Description
id	string	Unique identifier of the Webhook to be deleted.

204