Webhooks

List webhook subscriptions

Changed on

List all webhook subscriptions

get/webhook/webhooks

Request

  • Base URL: https://unify.apideck.com
  • URL: https://unify.apideck.com/webhook/webhooks
  • Auth: API key in header Authorization

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

Headers

x-apideck-app-idstring required

The ID of your Unify application

Response

Webhooks

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": "1234",
      "description": "A description",
      "unified_api": "crm",
      "status": "enabled",
      "disabled_reason": "retry_limit",
      "delivery_url": "https://example.com/my/webhook/endpoint",
      "execute_base_url": "https://unify.apideck.com/webhook/webhooks/1234/execute",
      "events": [
        "vault.connection.created",
        "vault.connection.updated"
      ],
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "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"
  }
}

Changes

  • 847fd789cfd3Revision changes
    • warning

      added the new accounting.refund.created enum value to the /// response property for the response status

    • warning

      added the new accounting.refund.deleted enum value to the /// response property for the response status

    • warning

      added the new accounting.refund.updated enum value to the /// response property for the response status

    • warning

      added the new accounting.sales_receipt.created enum value to the /// response property for the response status

    • warning

      added the new accounting.sales_receipt.deleted enum value to the /// response property for the response status

    • warning

      added the new accounting.sales_receipt.updated enum value to the /// response property for the response status

  • 3e4e70686422Revision changes
    • warning

      added the new ecommerce.order.delivered enum value to the /// response property for the response status

    • warning

      added the new ecommerce.order.paid enum value to the /// response property for the response status

    • warning

      added the new ecommerce.order.refunded enum value to the /// response property for the response status

    • warning

      added the new ecommerce.order.shipped enum value to the /// response property for the response status