Webhooks

Subscribe to webhook events

post

Creates a new webhook subscription for the specified event types. Used by Zapier REST Hook.

Authorizations

api_key

X-API-KEYstringRequired

Body

application/json

targetUrlstring · uriRequired

eventTypesstring[] · min: 1Required

namestringOptional

Responses

201

201

application/json

400

400

application/json

401

401

application/json

403

403

application/json

post

/clients/api/v1/webhooks/subscribe

HTTPcURLJavaScriptPython

POST /clients/api/v1/webhooks/subscribe HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "targetUrl": "https://example.com",
  "eventTypes": [
    "text"
  ],
  "name": "text"
}

{
  "id": "text",
  "hook0SubscriptionId": "text"
}

Unsubscribe from webhook

delete

Deletes a webhook subscription by ID. Used by Zapier REST Hook.

Authorizations

api_key

X-API-KEYstringRequired

Path parameters

idstringRequired

Body

application/json

objectOptional

Responses

204

204

application/json

401

401

application/json

403

403

application/json

404

404

application/json

delete

/clients/api/v1/webhooks/{id}

HTTPcURLJavaScriptPython

DELETE /clients/api/v1/webhooks/{id} HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

No content

List webhook subscriptions

get

Returns a paginated list of webhook subscriptions.

Authorizations

api_key

X-API-KEYstringRequired

Query parameters

pagenumber · nullableOptionalDefault: 1

limitnumber · nullableOptionalDefault: 10

Responses

200

200

application/json

401

401

application/json

403

403

application/json

get

/clients/api/v1/webhooks

HTTPcURLJavaScriptPython

GET /clients/api/v1/webhooks HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": "text",
      "targetUrl": "https://example.com",
      "eventTypes": [
        "text"
      ],
      "name": "text",
      "enabled": true,
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "meta": {
    "itemCount": 1,
    "totalItems": 10,
    "itemsPerPage": 1,
    "totalPages": 10,
    "currentPage": 1
  }
}

Get available trigger types

get

Returns a list of event types that can be subscribed to for triggers.

Authorizations

api_key

X-API-KEYstringRequired

Responses

200

200

application/json

eventTypestringRequired

displayNamestringRequired

descriptionstringRequired

sourcestring · enumRequiredPossible values:

401

401

application/json

403

403

application/json

get

/clients/api/v1/webhooks/trigger-types

HTTPcURLJavaScriptPython

GET /clients/api/v1/webhooks/trigger-types HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Accept: */*

[
  {
    "eventType": "text",
    "displayName": "text",
    "description": "text",
    "source": "api"
  }
]

Get available action types

get

Returns a list of API endpoints available as Zapier actions.

Authorizations

api_key

X-API-KEYstringRequired

Responses

200

200

application/json

keystringRequired

displayNamestringRequired

descriptionstringRequired

methodstring · enumRequiredPossible values:

endpointstringRequired

nounstringRequired

401

401

application/json

403

403

application/json

get

/clients/api/v1/webhooks/action-types

HTTPcURLJavaScriptPython

GET /clients/api/v1/webhooks/action-types HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Accept: */*

[
  {
    "key": "text",
    "displayName": "text",
    "description": "text",
    "method": "GET",
    "endpoint": "text",
    "noun": "text"
  }
]

Perform list for event type

get

Returns recent events for a specific event type. Used as a polling fallback by Zapier.

Authorizations

api_key

X-API-KEYstringRequired

Path parameters

eventTypestringRequired

Query parameters

limitnumber · nullableOptionalDefault: 50

Responses

200

200

application/json

Other propertiesanyOptional

401

401

application/json

403

403

application/json

get

/clients/api/v1/webhooks/perform/{eventType}

HTTPcURLJavaScriptPython

GET /clients/api/v1/webhooks/perform/{eventType} HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Accept: */*

[
  {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
]