How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webhooks API

Configure and manage webhook subscriptions and delivery for Zai/Assembly platform events.

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

This API exposes 6 JSON Schema definitions.

Tagged areas include Payments and Fintech. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

This API exposes 6 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.4.

Requests are made against 3 base URLs: https://sandbox.au-0000.api.assemblypay.com, https://au-0000.api.assemblypay.com, https://virtserver.swaggerhub.com/AssemblyPlatforms/WAPI/1.0.4.

6 operations 3 paths 8 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.4
Base URL
https://au-0000.api.assemblypay.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Webhooks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 6

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

Webhooks 6
POST
/webhooks
Create a Webhook
createWebhook body → 201400403409422500
GET
/webhooks
List Webhooks
getAllWebhooks 2 params → 200403500
POST
/webhooks/secret_key
Create a Secret Key
createSecretKey body → 201400403422500
GET
/webhooks/{uuid}
Show Webhook
getWebhookById 1 param → 200403404500
PATCH
/webhooks/{uuid}
Update an existing Webhook
updateWebhook 1 param body → 200400403404422500
DELETE
/webhooks/{uuid}
Delete Webhook by ID
deleteWebhookById 1 param → 200403404500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Webhook (9 properties), WebhookRequestBody (3 properties), UpdateWebhookRequestBody (3 properties), RequestResponses (3 properties). Each schema is shown below with its type and property counts.

Webhooks
object
2 properties
WebhookRequestBody
object
3 properties 3 required
SecretKeyRequestBody
object
1 property 1 required
Webhook
object
9 properties
RequestResponses
object
3 properties
UpdateWebhookRequestBody
object
3 properties
WebhookLinks
object
2 properties
APIResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

assembly-payments-webhooks-api-openapi.yml Raw ↑

Other APIs Assembly Payments publishes across the network.

Assembly Payments Addresses API
Assembly Payments Authentication API
Assembly Payments Bank Accounts API
Assembly Payments Batch Transactions API
Assembly Payments BPay Accounts API
Assembly Payments Callbacks API
Assembly Payments Card Accounts API
Assembly Payments Charges API
Assembly Payments Companies API
Assembly Payments Direct Debit Authorities API
Assembly Payments Disbursements API
Assembly Payments Failed NPP Payment Details API
Where this information came from

This is an independent, third-party profile of Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.