Sign in
Hook

List hooks

Retrieve all hook objects.

get/api/v1/hooks

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

namestring

Object name filter

type'webhook' | 'function'

Filter by hook type.

queueinteger[]

Queue ID(s) filter

activeboolean

Filter by active status.

config_urlstring

Filter by configuration URL.

config_app_urlstring

Filter by configuration app URL.

extension_source'custom' | 'rossum_store'

Filter by extension source.

eventsstring

Filter by events.

searchstring

Filter by name (case-insensitive) or id simultaneously

ordering'id' | '-id' | 'name' | '-name' | 'type' | '-type' | 'active' | '-active' | 'config_url' | '-config_url' | 'config_app_url' | '-config_app_url' | 'events' | '-events'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 1500,
      "type": "webhook",
      "name": "Change of Status",
      "url": "https://example.rossum.app/api/v1/hooks/1500",
      "queues": [
        "https://example.rossum.app/api/v1/queues/8199",
        "https://example.rossum.app/api/v1/queues/8191"
      ],
      "run_after": [],
      "integration_credentials": [],
      "active": true,
      "events": [
        "annotation_status.changed"
      ],
      "sideload": [
        "queues"
      ],
      "metadata": {
        "some_key": "some_value"
      },
      "token_owner": "https://example.rossum.app/api/v1/users/2",
      "token_lifetime_s": 1000,
      "test": {
        "saved_input": {}
      },
      "description": "This hook does...",
      "extension_source": "custom",
      "settings": {},
      "settings_schema": {
        "type": "object",
        "properties": {}
      },
      "secrets": {},
      "secrets_schema": {
        "type": "object",
        "additionalProperties": {
          "type": "string"
        }
      },
      "guide": "Here we explain how the extension should be used.",
      "read_more_url": "https://github.com/rossumai/simple-vendor-matching-webhook-python",
      "extension_image_url": "https://rossum.ai/wp-content/themes/rossum/static/img/logo.svg",
      "hook_template": "https://example.rossum.app/api/v1/hook_templates/998877",
      "created_by": "https://example.rossum.app/api/v1/users/2",
      "created_at": "2020-01-01T09:05:50.213451Z",
      "modified_by": "https://example.rossum.app/api/v1/users/10775",
      "modified_at": "2021-04-26T10:08:03.856648Z",
      "config": {
        "url": "https://myq.east-west-trading.com/api/hook1?strict=true",
        "secret": "secret-token",
        "client_ssl_certificate": "-----BEGIN CERTIFICATE-----\n...",
        "client_ssl_key": "-----BEGIN PRIVATE KEY-----\n...",
        "schedule": {
          "cron": "*/10 * * * *"
        },
        "timeout_s": 30,
        "retry_count": 4,
        "max_polling_time_s": 300,
        "retry_after_polling_failure": true,
        "app": {
          "url": "https://myq.east-west-trading.com/api/hook1?strict=true",
          "settings": {},
          "display_mode": "drawer"
        }
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.