contact.*

contact.list

List all active contacts under your account.

Parameters Bold parameters are required.

Name Type Description
token string Your API token

Response data

Result data contains an array/collection of contact data structure.

contact.add

Add a new contact. Please note that only web hook URL is added immediately, Slack and email must be confirmed by recipient first.

Parameters Bold parameters are required.

Name Type Description
token string Your API token
name string Name
type integer Contact type: 0 for email, 1 for Slack URL, 2 for web hook URL.
target string Contact email / slack URL / web hook URL

Response data

You'll get the data structure of newly created contact.

Example response

{"data":{"id":2,"name":"example"},"info":[],"status":"success","code":0}

contact.edit

Update an existing contact

Parameters Bold parameters are required.

Name Type Description
id integer Contact ID
name string Name
type integer Contact type: 0 for email, 1 for Slack URL, 2 for web hook URL.
target string Contact email / slack URL / web hook URL

Response data

You'll get the structure of updated contact.

contact.delete

Delete a contact

Parameters Bold parameters are required.

Name Type Description
token string Your API token
id integer Contact ID

Response data

You'll get the structure of deleted contact, with ID set to null.