v1

latestOpenAPI 3.0.3Apache 2.02026-07-13103980.6 KB

Webhooks

List event logs

get/webhook/logs

Query parameters

cursorstring nullable

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger

Number of results to return. Minimum 1, Maximum 200, Default 20

exclude_apisstring nullable

consumer_idstring nullable

entity_typestring nullable

event_typestring nullable

start_datestring date-time nullable

Filter logs at or after this ISO 8601 date-time (inclusive).

end_datestring date-time nullable

Filter logs at or before this ISO 8601 date-time (inclusive). Must be on or after start_date.

successboolean nullable

Filter by delivery success or failure.

status_codenumber nullable

Filter by a single HTTP status code. For backward compatibility - use status_codes for multiple values.

status_codesnumber[] nullable

Filter by multiple HTTP status codes. Values must be between 100-599. Maximum 50 status codes allowed.

event_idstring nullable

Filter by webhook event ID.

execution_attemptnumber nullable

Filter by the delivery attempt number.

Filter results

{
  "exclude_apis": "vault,proxy",
  "consumer_id": "test_user_id",
  "entity_type": "Connection",
  "event_type": "vault.connection.callable",
  "start_date": "2024-01-01T00:00:00.000Z",
  "end_date": "2024-01-31T23:59:59.999Z",
  "status_code": 201,
  "status_codes": [
    200,
    201,
    204
  ]
}

Headers

x-apideck-app-idstring required

The ID of your Unify application

Response

EventLogs

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "data": [
    {
      "id": "1d174c4d-fe9e-4377-a76c-6da22fe9cd87",
      "status_code": 200,
      "success": true,
      "application_id": "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
      "consumer_id": "test_consumer_id",
      "unified_api": "crm",
      "service": {
        "id": "101-data-solution",
        "name": "101 Data Solution"
      },
      "endpoint": "https://example.com/my/webhook/endpoint",
      "event_type": "vault.connection.updated",
      "execution_attempt": 3,
      "http_method": "GET",
      "timestamp": "2021-07-12T14:26:17.420Z",
      "entity_type": "Connection",
      "request_body": "{\"entity\":{\"id\":\"2222+test_user_id\",\"application_id\":\"2222\",\"consumer_id\":\"test_user_id\",\"name\":\"ActiveCampaign\",\"icon\":\"https://res.cloudinary.com/apideck/image/upload/v1529455970/catalog/activecampaign/icon128x128.png\",\"logo\":\"https://www.activecampaign.com/site/assets/social-2x.png\",\"unified_api\":\"crm\",\"service_id\":\"activecampaign\",\"auth_type\":\"apiKey\",\"enabled\":true,\"tag_line\":\"Integrated email marketing, marketing automation, and small business CRM. Save time while growing your business with sales automation.\",\"website\":\"https://www.activecampaign.com/\",\"settings\":{\"instance_url\":\"https://eu28.salesforce.com\",\"base_url\":\"https://updated.api-us1.com\"},\"metadata\":{\"plan\":\"enterprise\",\"account\":{\"name\":\"My Company\"}},\"state\":\"callable\",\"created_at\":\"2021-09-10T10:39:49.628Z\",\"updated_at\":\"2021-09-10T10:39:52.715Z\"},\"entityType\":\"Connection\"}",
      "response_body": "{\"status\":\"OK\"}",
      "retry_scheduled": true,
      "attempts": [
        {
          "timestamp": "2021-07-12T14:26:17.420Z",
          "execution_attempt": 3,
          "status_code": 200,
          "success": true
        }
      ]
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "operation": "getManager"
      }
    ]
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}