API Documentation

Overview

Authentication

We use the HTTP Basic Authentication to authenticate API requests. You can get your API key from the Account Settings page when logged into your MailingReport account.

The API access is stateless so you need to provide your credentials on every request.

Output format

The MailingReport APIs return HTTP responses only in JSON format. Every string return from the MailingReport API are UTF-8 encoded.

HTTPS / Secure Connections

We require that all requests are done over SSL.

Endpoint

All MailingReport API requests start with api.mgrt.net. The next segment of the URI path depends on the type of request.

REST

This API have been written to follow the REST architecture.

Account

GET /account

Return

Parameter Type Description
company string The Company Name
address_street string Street
address_city string City
address_zipcode string Zip code
address_country string Country
timezone string Time zone
currency string Currency
plan_type string Selected plan type
credits integer Available credits

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when account is not found

Api Keys

GET /api-keys

Filters

Name Requirement Description
page \d+ Page of the overview.
limit \d+ Max results per page. 1 to 50. Default 50.
sort (createdAt) Sort field
direction (asc|desc) Sort direction

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when api keys are not found
POST /api-keys

Parameters

Parameter Type Required? Description
api_key[name] string true

Return

Parameter Type Description
name string The Api Key Name
id integer The Api Key Id
public_key string The Api Key Public Key
secret_key string The Api Key's Secret key
created_at DateTime The Api Key's Create date
disabled_at DateTime The Api Key's Disable date

Status Codes

Status Code Description
201 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
GET /api-keys/{apiKeyId}

Requirements

Name Requirement Type Description
apiKeyId \d+ integer Id for the api key to show

Return

Parameter Type Description
name string The Api Key Name
id integer The Api Key Id
public_key string The Api Key Public Key
secret_key string The Api Key's Secret key
created_at DateTime The Api Key's Create date
disabled_at DateTime The Api Key's Disable date

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when api key is not found
PUT /api-keys/{apiKeyId}

Requirements

Name Requirement Type Description
apiKeyId \d+ integer Id for the api key to edit

Parameters

Parameter Type Required? Description
api_key[name] string true

Status Codes

Status Code Description
204 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
DELETE /api-keys/{apiKeyId}

Requirements

Name Requirement Type Description
apiKeyId \d+ integer Id for the api key to delete

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when api key is not found
PUT /api-keys/{apiKeyId}/disable

Requirements

Name Requirement Type Description
apiKeyId \d+ integer Id for the api key to show

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when api key is not found
PUT /api-keys/{apiKeyId}/enable

Requirements

Name Requirement Type Description
apiKeyId \d+ integer Id for the api key to show

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when api key is not found

Campaigns

GET /campaigns

Filters

Name Requirement Description
status (sent|drafted|scheduled|sending) Campaign status
page \d+ Page of the overview.
limit \d+ Max results per page. 1 to 50. Default 50.
sort (name|createdAt|sentAt) Sort field. Default name.
direction (asc|desc) Sort direction. Default asc.
public (0|1) Get all, private or public campaigns.

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when campaigns are not found
POST /campaigns

Parameters

Parameter Type Required? Description
campaign[name] string true The Campaign name
campaign[subject] string false The Campaign subject
campaign[fromMail] string false The Campaign from email
campaign[fromName] string false The Campaign from name
campaign[replyMail] string false The Campaign reply email
campaign[body] string false The Campaign HTML body
campaign[mailingLists] string false Mailing lists that will receive the campaign

Return

Parameter Type Description
name
fromMail
replyMail
mailingLists
segments
body
mockup
subject
sendDateSchedule
id integer The Campaign id

Status Codes

Status Code Description
201 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
GET /campaigns/summary

Return

Parameter Type Description
total_count integer Returns the total number of your campaigns
sending_count integer Returns the number of your campaigns being sent
sent_count integer Returns the number of your campaigns have been sent
drafted_count integer Returns the number of your campaigns in draft
scheduled_count integer Returns the number of your scheduled campaigns

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
GET /campaigns/{campaignId}

Requirements

Name Requirement Type Description
campaignId \d+ integer

Return

Parameter Type Description
id integer The Campaign id
mailing_lists[] array of objects (MailingList)
      mailing_lists[][id] integer The Mailing List Id
      mailing_lists[][name] string The Mailing List Name
      mailing_lists[][created_at] DateTime The Mailing List's Create date
      mailing_lists[][updated_at] DateTime The Mailing List's Update date
name string The Campaign name
subject string The Campaign subject
body string The Campaign html body
from_mail string The Campaign from email
from_name string The Campaign from name
reply_mail string The Campaign reply email
scheduled_at DateTime The Campaign's scheduled date
sent_at DateTime The campaign's send date
tracking_ends_at DateTime The Campaign tracking date end
created_at DateTime The Campaign's created date
updated_at DateTime The Campaign's updated date
status string The Campaign status

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when campaign is not found
PATCH /campaigns/{campaignId}

Requirements

Name Requirement Type Description
campaignId \d+ integer Id for the campaign to update

Parameters

Parameter Type Required? Description
campaign[name] string true The Campaign name
campaign[subject] string false The Campaign subject
campaign[fromMail] string false The Campaign from email
campaign[fromName] string false The Campaign from name
campaign[replyMail] string false The Campaign reply email
campaign[body] string false The Campaign HTML body
campaign[mailingLists] string false Mailing lists that will receive the campaign

Status Codes

Status Code Description
204 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
PUT /campaigns/{campaignId}

Requirements

Name Requirement Type Description
campaignId \d+ integer Id for the campaign to update

Parameters

Parameter Type Required? Description
campaign[name] string true The Campaign name
campaign[subject] string false The Campaign subject
campaign[fromMail] string false The Campaign from email
campaign[fromName] string false The Campaign from name
campaign[replyMail] string false The Campaign reply email
campaign[body] string false The Campaign HTML body
campaign[mailingLists] string false Mailing lists that will receive the campaign

Status Codes

Status Code Description
204 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
DELETE /campaigns/{campaignId}

Requirements

Name Requirement Type Description
campaignId \d+ integer Id for the drafted campaign to delete

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when campaign is not found
PUT /campaigns/{campaignId}/schedule

Requirements

Name Requirement Type Description
campaignId \d+ integer Id for the campaign to update

Parameters

Parameter Type Required? Description
campaign[sendDateSchedule] datetime true The schedule date

Status Codes

Status Code Description
204 Returned when successful
400 Returned when campaign is not completly filled
401 Returned when credentials are invalid
404 Returned when campaign are not found
GET /campaigns/{campaignId}/summary

Requirements

Name Requirement Type Description
campaignId \d+ integer

Return

Parameter Type Description
id integer The Campaign id
sent_count integer Returns the total number of sent mails
opened_count integer Returns the total number of opened mails
unique_clicked_count integer Returns the total number of unique clicks
total_clicked_count integer Returns the total number of clicks
delivery_count integer Returns the total number of delivered mails
forwarded_count integer Returns the total number of forwarded mails
printed_count integer Returns the total number of printed mails
unsubscribed_count integer Returns the total number of unsubscribed mails
spamed_count integer Returns the total number of spamed mails
bounced_count integer Returns the total number of bounced mails
opened_rate float Returns the percentage of mails opened relative to the number of mails delivered
total_clicked_rate float Returns the percentage of mails clicked relative to the number of mails delivered
unique_clicked_rate float Returns the percentage of mails clicked once relative to the number of mails delivered
forwarded_rate float Returns the percentage of mails forwarded relative to the number of mails delivered
printed_rate float Returns the percentage of mails printed relative to the number of mails delivered
unsubscribed_rate float Returns the percentage of mails unsubscribed relative to the number of mails delivered
bounced_rate float Returns the percentage of mails bounced relative to the number of mails sent
spamed_rate float Returns the percentage of mails spamed relative to the number of mails delivered

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when campaign is not found
PUT /campaigns/{campaignId}/unschedule

Requirements

Name Requirement Type Description
campaignId \d+ integer Id for the campaign to unschedule

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when campaign are not found

Contacts

GET /contacts

Filters

Name Requirement Description
page \d+ Page of the overview.
limit \d+ Max results per page. 1 to 100. Default 100.
sort (email|createdAt|lastActivity) Sort field
direction (asc|desc) Sort direction
status (active|bounced|unsubscribed|all) Contact status needed.

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when contacts are not found
POST /contacts

Parameters

Parameter Type Required? Description
contact[email] string true

Return

Parameter Type Description
email string The Contact Email
customFieldsValues
id integer The Contact Id
mailing_lists[] array of objects (MailingList) The Contact's Mailing lists
      mailing_lists[][id] integer The Mailing List Id

Status Codes

Status Code Description
201 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
GET /contacts/summary

Return

Parameter Type Description
total_count integer Returns the total number of your contacts
active_count integer Returns the number of your active contacts
bounced_count integer Returns the number of your bounced contacts
unsubscribed_count integer Returns the number of your unsubscribed contacts
awaiting_count integer Returns the number of your awaiting confirmation

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
GET /contacts/{contactId}

Requirements

Name Requirement Type Description
contactId \d+ integer Id for the contact to show

Return

Parameter Type Description
id integer The Contact Id
mailing_lists[] array of objects (MailingList) The Contact's Mailing lists
      mailing_lists[][id] integer The Mailing List Id
      mailing_lists[][name] string The Mailing List Name
      mailing_lists[][created_at] DateTime The Mailing List's Create date
      mailing_lists[][updated_at] DateTime The Mailing List's Update date
email string The Contact Email
latitude float The Contact Latitude
longitude float The Contact Longitude
city string The Contact City
country_code string The Contact Country code
time_zone string The Contact Time zone
last_activity DateTime The Contact's Last activity date
created_at DateTime The Contact's Creating date
updated_at DateTime The Contact's Updating date
bounced_at DateTime The Contact's Bouncing date
unsubscribed_at DateTime The Contact's Unsubscribing date

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when contact is not found
PATCH /contacts/{contactId}

Requirements

Name Requirement Type Description
contactId \d+ integer Id for the contact to edit

Parameters

Parameter Type Required? Description
contact[email] string true

Status Codes

Status Code Description
204 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
PUT /contacts/{contactId}

Requirements

Name Requirement Type Description
contactId \d+ integer Id for the contact to edit

Parameters

Parameter Type Required? Description
contact[email] string true

Status Codes

Status Code Description
204 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
DELETE /contacts/{contactId}

Requirements

Name Requirement Type Description
contactId \d+ integer Id of the contact to unsubscribe

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when contact is not found
GET /contacts/{contactId}/history

Requirements

Name Requirement Type Description
contactId \d+ integer

Filters

Name Requirement Description
page \d+ Page of the overview.
limit \d+ Max results per page. 1 to 50. Default 50.
sort (createdAt) Sort field
direction (asc|desc) Sort direction

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when contact is not found
PUT /contacts/{contactId}/resubscribe

Requirements

Name Requirement Type Description
contactId \d+ integer Id of the contact to resubscribe

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when contact is not found
GET /contacts/{contactId}/summary

Requirements

Name Requirement Type Description
contactId \d+ integer

Return

Parameter Type Description
id integer The Campaign id
received_count integer Returns the total number of mails received by the contact
total_opened_count integer Returns the total number of mails opened by the contact
total_clicked_count integer Returns the total number of mails clicked by the contact
opened_rate integer Returns the opening rate of the contact
clicked_rate integer Returns the click rate of the contact

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when contact is not found
PUT /contacts/{contactId}/unsubscribe

Requirements

Name Requirement Type Description
contactId \d+ integer Id of the contact to unsubscribe

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when contact is not found
GET /contacts/{email}

Requirements

Name Requirement Type Description
email .*@.* integer Email for the contact to show

Return

Parameter Type Description
id integer The Contact Id
mailing_lists[] array of objects (MailingList) The Contact's Mailing lists
      mailing_lists[][id] integer The Mailing List Id
      mailing_lists[][name] string The Mailing List Name
      mailing_lists[][created_at] DateTime The Mailing List's Create date
      mailing_lists[][updated_at] DateTime The Mailing List's Update date
email string The Contact Email
latitude float The Contact Latitude
longitude float The Contact Longitude
city string The Contact City
country_code string The Contact Country code
time_zone string The Contact Time zone
last_activity DateTime The Contact's Last activity date
created_at DateTime The Contact's Creating date
updated_at DateTime The Contact's Updating date
bounced_at DateTime The Contact's Bouncing date
unsubscribed_at DateTime The Contact's Unsubscribing date

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when contact is not found

Core

GET /hello-world

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
GET /system-date

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid

Custom Fields

GET /custom-fields

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when custom fields are not found

Domains

GET /domains

Filters

Name Requirement Description
page \d+ Page of the overview.
limit \d+ Max results per page. 1 to 50. Default 50.
sort (domainName|createdAt) Sort field
direction (asc|desc) Sort direction

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when domains are not found
GET /domains/{domainId}

Requirements

Name Requirement Type Description
domainId \d+ integer Id for the domain to show

Return

Parameter Type Description
id integer The Domain Id
domain_name string The Domain Name
public_key string The Domain Public key
dkim_status integer The Domain DKIM (DomainKeys Identified Mail) status
spf_status integer The Domain SPF (Sender Policy Framework) status
checked_at DateTime The Domain Check date

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when domain is not found
PUT /domains/{domainId}/check

Requirements

Name Requirement Type Description
domainId \d+ integer Id for the domain to check

Return

Parameter Type Description
id integer The Domain Id
domain_name string The Domain Name
public_key string The Domain Public key
dkim_status integer The Domain DKIM (DomainKeys Identified Mail) status
spf_status integer The Domain SPF (Sender Policy Framework) status
checked_at DateTime The Domain Check date

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when domain is not found

Invoices

GET /invoices

Filters

Name Requirement Description
page \d+ Page of the overview.
limit \d+ Max results per page. 1 to 50. Default 50.
sort (totalAmount|createdAt) Sort field
direction (asc|desc) Sort direction

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when invoices are not found
GET /invoices/{invoiceId}

Requirements

Name Requirement Type Description
invoiceId \d+ integer Id for the invoice to show

Return

Parameter Type Description
id integer The Invoice Id
currency string The Invoice Currency
invoice_lines[] array of objects (InvoiceLine) The Invoice Lines
      invoice_lines[][title] string The Invoice Line Title
      invoice_lines[][description] string The Invoice Line Description
      invoice_lines[][quantity] integer The Invoice Line Quantity
      invoice_lines[][price] float The Invoice Line Price
net_amount float The Invoice Net amount
tax_amount float The Invoice Tax amount
total_amount float The Invoice Total amount
due_at DateTime The Invoice Due date
paid_at DateTime The Invoice Pay date

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when invoice is not found

Mailing lists

GET /mailing-lists

Filters

Name Requirement Description
page \d+ Page of the overview.
limit \d+ Max results per page. 1 to 100. Default 100.
sort (name|createdAt) Sort field
direction (asc|desc) Sort direction

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when mailing lists are not found
POST /mailing-lists

Parameters

Parameter Type Required? Description
mailing_list[name] string true

Return

Parameter Type Description
name
id integer The Mailing List Id

Status Codes

Status Code Description
201 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
GET /mailing-lists/{mailingListId}

Requirements

Name Requirement Type Description
mailingListId \d+ integer Id for the mailing list to show

Return

Parameter Type Description
name string The Mailing List Name
id integer The Mailing List Id
created_at DateTime The Mailing List's Create date
updated_at DateTime The Mailing List's Update date

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when mailing list is not found
PUT /mailing-lists/{mailingListId}

Requirements

Name Requirement Type Description
mailingListId \d+ integer Id for the mailing list to update

Parameters

Parameter Type Required? Description
mailing_list[name] string true

Status Codes

Status Code Description
204 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
DELETE /mailing-lists/{mailingListId}

Requirements

Name Requirement Type Description
mailingListId \d+ integer Id of the mailing list to delete

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when mailing list is not found
GET /mailing-lists/{mailingListId}/contacts

Requirements

Name Requirement Type Description
mailingListId \d+ integer Id for the mailing list

Filters

Name Requirement Description
page \d+ Page of the overview.
limit \d+ Max results per page. 1 to 100. Default 100.
status (active|bounced|unsubscribed|all) Contact status needed.
sort (email|createdAt|lastActivity) Sort field
direction (asc|desc) Sort direction

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when mailing list or contacts are not found

Mails

GET /mails/summary

Return

Parameter Type Description
sent_count integer Returns the total number of your sent mails
opened_count integer Returns the total number of opened mails
unique_clicked_count integer Returns the total number of unique clicks
total_clicked_count integer Returns the total number of clicks
delivered_count integer Returns the total number of delivered mails
forwarded_count integer Returns the total number of forwarded mails
printed_count integer Returns the total number of printed mails
unsubscribed_count integer Returns the total number of unsubscribed mails
spamed_count integer Returns the total number of spamed mails
bounced_count integer Returns the total number of bounced mails
opened_rate float Returns the percentage of mails opened relative to the number of mails delivered
total_clicked_rate float Returns the percentage of mails clicked relative to the number of mails delivered
unique_clicked_rate float Returns the percentage of mails clicked once relative to the number of mails delivered
forwarded_rate float Returns the percentage of mails forwarded relative to the number of mails delivered
printed_rate float Returns the percentage of mails printed relative to the number of mails delivered
unsubscribed_rate float Returns the percentage of mails unsubscribed relative to the number of mails delivered
bounced_rate float Returns the percentage of mails bounced relative to the number of mails sent
spamed_rate float Returns the percentage of mails spamed relative to the number of mails delivered

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
GET /mails/{mailId}/summary

Requirements

Name Requirement Type Description
mailId \d+

Return

Parameter Type Description
id integer Return the mail id
from_name string Return the from name
from_mail string Return the from email
contact_id integer Return the contact id
contact_email string Return the contact email
mail_subject string Return the subject
mail_links[] array of objects (Link) Return the tracked links
      mail_links[][original_url] string
      mail_links[][count_total_click] integer
      mail_links[][position] integer
mail_history array Return the mail history

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when mail was not found

Senders

GET /senders

Filters

Name Requirement Description
page \d+ Page of the overview.
limit \d+ Max results per page. 1 to 50. Default 50.
sort (email|createdAt) Sort field
direction (asc|desc) Sort direction

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when senders are not found
GET /senders/{senderId}

Requirements

Name Requirement Type Description
senderId \d+ integer Id for the sender to show

Return

Parameter Type Description
id integer The Sender Id
email string The Sender Email
email_type integer The Sender Email's type
is_enabled boolean The Sender Email's status

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when sender is not found
DELETE /senders/{senderId}

Requirements

Name Requirement Type Description
senderId \d+ integer Id for the sender to delete

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when sender is not found

Templates

GET /templates

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when templates are not found
POST /templates

Parameters

Parameter Type Required? Description
template[name] string true
template[mockup] string false
template[body] string false

Return

Parameter Type Description
id string
name string
body string
mockup string
created_at DateTime
updated_at DateTime

Status Codes

Status Code Description
201 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
GET /templates/{templateId}

Requirements

Name Requirement Type Description
templateId [a-z0-9-]+ integer Id for the template to show

Return

Parameter Type Description
id string
name string
body string
mockup string
created_at DateTime
updated_at DateTime

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when template is not found
PUT /templates/{templateId}

Requirements

Name Requirement Type Description
templateId [a-z0-9-]+ integer Id for the template to edit

Parameters

Parameter Type Required? Description
template[name] string true
template[mockup] string false
template[body] string false

Status Codes

Status Code Description
204 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
DELETE /templates/{templateId}

Requirements

Name Requirement Type Description
templateId [a-z0-9-]+ integer Id for the template to delete

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when template is not found

Webhooks

GET /webhooks

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when webhooks are not found
POST /webhooks

Parameters

Parameter Type Required? Description
create_webhook[name] string true
create_webhook[callbackUrl] string true
create_webhook[listenedEvents] string false
create_webhook[listenedSources] string false

Return

Parameter Type Description
id string
name string
callback_url string
listened_events array
listened_sources array
secret_key string
enabled boolean
created_at DateTime
updated_at DateTime

Status Codes

Status Code Description
201 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
GET /webhooks/{webhookId}

Requirements

Name Requirement Type Description
webhookId [a-z0-9-]+ integer Id for the webhook to show

Return

Parameter Type Description
id string
name string
callback_url string
listened_events array
listened_sources array
secret_key string
enabled boolean
created_at DateTime
updated_at DateTime

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when webhook is not found
PUT /webhooks/{webhookId}

Requirements

Name Requirement Type Description
webhookId [a-z0-9-]+

Parameters

Parameter Type Required? Description
edit_webhook[name] string true
edit_webhook[callbackUrl] string true
edit_webhook[listenedEvents] string false
edit_webhook[listenedSources] string false

Status Codes

Status Code Description
204 Returned when successful
400 Returned when sent data are invalid
401 Returned when credentials are invalid
DELETE /webhooks/{webhookId}

Requirements

Name Requirement Type Description
webhookId [a-z0-9-]+ integer Id for the webhook to delete

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when webhook is not found
PUT /webhooks/{webhookId}/disable

Requirements

Name Requirement Type Description
webhookId [a-z0-9-]+ integer Id for the webhook to deactivate

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when webhook is not found
PUT /webhooks/{webhookId}/enable

Requirements

Name Requirement Type Description
webhookId [a-z0-9-]+ integer Id for the webhook to activate

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when webhook is not found
PUT /webhooks/{webhookId}/reset-key

Requirements

Name Requirement Type Description
webhookId [a-z0-9-]+ integer Id for the webhook to reset

Return

Parameter Type Description
id string
name string
callback_url string
listened_events array
listened_sources array
secret_key string
enabled boolean
created_at DateTime
updated_at DateTime

Status Codes

Status Code Description
200 Returned when successful
401 Returned when credentials are invalid
404 Returned when webhook is not found
PUT /webhooks/{webhookId}/trigger-test

Requirements

Name Requirement Type Description
webhookId [a-z0-9-]+ integer Id for the webhook to deactivate

Status Codes

Status Code Description
204 Returned when successful
401 Returned when credentials are invalid
404 Returned when webhook is not found