Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ironclad Webhooks API

Documentation on Ironclad Webhooks.

Ironclad Webhooks API is one of 13 APIs that Ironclad publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a JSON-LD context, and 5 JSON Schemas.

This API exposes 6 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.

Requests are made against 3 base URLs: https://na1.ironcladapp.com/oauth, https://eu1.ironcladapp.com/oauth, https://demo.ironcladapp.com/oauth.

6 operations 3 paths 4 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1
Base URL
https://na1.ironcladapp.com/public/api/v1
Resource Areas
1

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Webhooks 6

Documentation on Ironclad Webhooks.

POST
/webhooks
Create a Webhook
create-a-webhook 2 params body → 201400
GET
/webhooks
List All Webhooks
list-all-webhooks 4 params → 200400
GET
/webhooks/{id}
Retrieve a Webhook
retrieve-a-webhook 3 params → 200400
PATCH
/webhooks/{id}
Update a Webhook
update-a-webhook 3 params body → 200400
DELETE
/webhooks/{id}
Delete a Webhook
delete-a-webhook 3 params → 204400
GET
/webhooks/verification-key
Retrieve Webhook Verification Key
retrieve-webhook-verification-key 2 params → 200400

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are WebhookModel (9 properties), WebhookTargetURLExistsBadRequestResponse (3 properties), WebhookInvalidEventTypeBadRequestResponse (3 properties). Each schema is shown below with its type and property counts.

WebhookInvalidEventTypeBadRequestResponse
object
3 properties
WebhookEvent
string
Events that can be subscribed to using a webhook.
WebhookModel
object
Webhook object describing the subscribed events and target URL to be called.
9 properties 6 required
WebhookTargetURLExistsBadRequestResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ironclad-webhooks-api-openapi.yml Raw ↑

Other APIs Ironclad publishes across the network.

Ironclad Clickwrap API
Ironclad Authorization API
Ironclad Entities API
Ironclad Exports API
Ironclad Groups API
Ironclad Obligations API
Ironclad Records API
Ironclad Resources API
Ironclad Schemas API
Ironclad Search API
Ironclad Users API
Ironclad Workflows API