Skip to content
This repository has been archived by the owner on Sep 26, 2024. It is now read-only.

Commit

Permalink
Webhook API endpoints updated with order
Browse files Browse the repository at this point in the history
  • Loading branch information
escopecz committed Aug 10, 2017
1 parent 38fd0e3 commit 99fab35
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions source/includes/_api_endpoint_webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ $webhook = $webhookApi->get($id);
"name": "test",
"description": "Created via API",
"webhookUrl": "https:\/\/johndoe.com",
"eventsOrderbyDir": "DESC",
"category": {
"createdByUser": "John Doe",
"modifiedByUser": "John Doe",
Expand Down Expand Up @@ -74,6 +75,7 @@ id|int|ID of the webhook
name|string|Title of the webhook
description|string|Description of the webhook
webhookUrl|string|Url to send the webhook payload to
eventsOrderbyDir| Order direction for queued events in one webhook. Can be "DESC" or "ASC"
isPublished|bool|Published state
publishUp|datetime/null|Date/time when the webhook should be published
publishDown|datetime/null|Date/time the webhook should be un published
Expand Down Expand Up @@ -109,6 +111,7 @@ $webhooks = $webhookApi->getList($searchFilter, $start, $limit, $orderBy, $order
"name": "Deleted contact",
"description": "Notify me when a contact is deleted",
"webhookUrl": "https:\/\/johndoe.com",
"eventsOrderbyDir": "DESC",
"category": null,
"triggers": [
"mautic.lead_post_delete",
Expand Down Expand Up @@ -151,6 +154,7 @@ $data = array(
'name' => 'test',
'description' => 'Created via API',
'webhookUrl' => 'http://some.url',
'eventsOrderbyDir' => "ASC",
'triggers' => array(
'mautic.lead_post_save_update',
'mautic.lead_post_save_new',
Expand All @@ -173,6 +177,7 @@ id|int|ID of the webhook
name|string|Title of the webhook
description|string|Description of the webhook
webhookUrl|string|URL to send the webhook payload to
eventsOrderbyDir| Order direction for queued events in one webhook. Can be "DESC" or "ASC"
isPublished|bool|Published state

#### Response
Expand Down Expand Up @@ -220,6 +225,7 @@ id|int|ID of the webhook
name|string|Title of the webhook
description|string|Description of the webhook
webhookUrl|string|Url to send the webhook payload to
eventsOrderbyDir| Order direction for queued events in one webhook. Can be "DESC" or "ASC"
isPublished|bool|Published state

#### Response
Expand Down

0 comments on commit 99fab35

Please sign in to comment.