IRironcladapp
Webhooks

List All Webhooks

Changed on

View all webhooks associated with a specific company with filtering available via query parameters.

OAuth Scope required: public.webhooks.readWebhooks

get/webhooks

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/webhooks
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.webhooks.readWebhooks

Query parameters

pageinteger

The page number used when paginating through a list of results.

pageSizeinteger

A limit of the number of results to return.

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Response

200

pageinteger required
pageSizeinteger required

Example response

{
  "pageSize": 20,
  "list": [
    {
      "id": "5928719b30182d3700364a74",
      "events": [
        "workflow_launched"
      ],
      "targetURL": "https://develop.ironcladapp.com",
      "companyId": "5928719b30182d3700364a74",
      "status": "enabled",
      "statusLastUpdatedAt": "2025-01-17T17:51:49.008Z",
      "statusLastUpdatedBy": "system",
      "firstConsecutiveFailure": "2025-01-17T17:51:49.008Z"
    }
  ]
}

Changes

  • 435da5a4396eRevision changes
    • warning

      added the new workflow_deleted enum value to the /// response property for the response status