Assembly Payments

Assembly Payments Jobs API

The Jobs API from Assembly Payments — 2 operation(s) for jobs.

Documentation GitHub OpenAPI

Business capability

Webhook & Event Subscription Management BC-4270.80

Operations 2

GET /webhooks/{uuid}/jobs Get jobs associated to Webhook #

GET /webhooks/{uuid}/jobs/{jobUUID} Show job associated to Webhook #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/assembly-payments:assembly-payments-jobs-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: This is the Swagger definition for the AssemblyPayment's Webhooks API
  version: 1.0.4
  title: Webhooks Jobs API
  contact:
    email: support@assemblypayments.com
    url: http://docs.assemblypayments.com/
servers:
- url: https://sandbox.au-0000.api.assemblypay.com
  description: Sandbox (Pre-live) server and API
- url: https://au-0000.api.assemblypay.com
  description: Production server and API
- url: https://virtserver.swaggerhub.com/AssemblyPlatforms/WAPI/1.0.4
  description: SwaggerHub API Auto Mocking
security:
- bearerAuth: []
tags:
- name: Jobs
paths:
  /webhooks/{uuid}/jobs:
    get:
      tags:
      - Jobs
      summary: Get jobs associated to Webhook
      description: Retrieve an ordered and paginated list of the jobs garnered from a webhook using a given `:id`.
      parameters:
      - name: uuid
        in: path
        description: ID of webhook
        required: true
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      - name: status
        in: query
        description: Narrow down records per status
        style: form
        explode: true
        schema:
          type: string
          enum:
          - success
          - failed
          - ''
          default: ''
        example: success
      - name: object_id
        in: query
        description: Narrow down records per object_id
        style: form
        explode: true
        schema:
          type: string
          default: ''
      operationId: getJobs
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Jobs'
              examples:
                response:
                  value:
                    jobs:
                    - hashed_payload: '32187'
                      updated_at: '2009-11-11T18:00:00+12:00'
                      created_at: '2021-03-18T05:31:32.867255Z'
                      object_id: buyer-123456
                      payload:
                        accounts:
                          account_type_id: 9100
                          amount: 0
                          created_at: '2019-11-27T00:04:41.675Z'
                          currency_id: 1
                          id: 20849
                          legal_entity_id: 5769
                          links:
                            self: null
                          updated_at: '2019-11-27T00:04:41.675Z'
                          uuid: 6f348690-f2d7-0137-3328-0242ac110003
                      webhook_uuid: 088e4cf1-2508-4bd4-97ab-a78e4e869970
                      uuid: d98133ca-9a2e-4322-9610-62b2faf78476
                      request_responses:
                      - response_code: 500
                        message: ''
                        created_at: '2021-05-24T06:54:32.019211768Z'
                      - response_code: 500
                        message: ''
                        created_at: '2021-05-24T06:54:32.019211768Z'
                      - response_code: 202
                        message: ''
                        created_at: '2021-05-24T07:24:34.156212905Z'
                    links:
                      self: /webhooks/088e4cf1-2508-4bd4-97ab-a78e4e869970/jobs?limit=2
                      webhooks: /webhooks
                    meta:
                      limit: 2
                      offset: 0
                      total: 10
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse'
              examples:
                response:
                  value:
                    status: Invalid Status
                    message: valid status are success or failed
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse'
              examples:
                response:
                  value:
                    status: Forbidden
                    message: empty token
        '404':
          description: Webhook not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse'
              examples:
                response:
                  value:
                    status: Not Found
                    message: resource not found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse'
              examples:
                response:
                  value:
                    status: Internal Server Error
                    message: error fetching jobs
      security:
      - bearerAuth: []
  /webhooks/{uuid}/jobs/{jobUUID}:
    get:
      tags:
      - Jobs
      summary: Show job associated to Webhook
      description: Show details of a specific **Job** response using a given `:id`.
      operationId: getJob
      parameters:
      - name: uuid
        in: path
        description: ID of webhook
        required: true
        schema:
          type: string
          format: uuid
      - name: jobUUID
        in: path
        description: ID of Job
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
              examples:
                response:
                  value:
                    hashed_payload: '32187'
                    updated_at: '2009-11-11T18:00:00+12:00'
                    created_at: '2021-03-18T05:31:32.867255Z'
                    object_id: buyer-123456
                    payload:
                      accounts:
                        account_type_id: 9100
                        amount: 0
                        created_at: '2019-11-27T00:04:41.675Z'
                        currency_id: 1
                        id: 20849
                        legal_entity_id: 5769
                        links:
                          self: null
                        updated_at: '2019-11-27T00:04:41.675Z'
                        uuid: 6f348690-f2d7-0137-3328-0242ac110003
                    webhook_uuid: 088e4cf1-2508-4bd4-97ab-a78e4e869970
                    uuid: d98133ca-9a2e-4322-9610-62b2faf78476
                    request_responses:
                    - response_code: 500
                      message: ''
                      created_at: '2021-05-24T06:54:32.019211768Z'
                    - response_code: 500
                      message: ''
                      created_at: '2021-05-24T06:54:32.019211768Z'
                    - response_code: 202
                      message: ''
                      created_at: '2021-05-24T07:24:34.156212905Z'
                    links:
                      self: /webhooks/088e4cf1-2508-4bd4-97ab-a78e4e869970/jobs/d98133ca-9a2e-4322-9610-62b2faf78476
                      jobs: /webhooks/088e4cf1-2508-4bd4-97ab-a78e4e869970/jobs/
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse'
              examples:
                response:
                  value:
                    status: Forbidden
                    message: empty token
        '404':
          description: not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse'
              examples:
                response:
                  value:
                    status: Not Found
                    message: resource not found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse'
              examples:
                response:
                  value:
                    status: Internal Server Error
                    message: error fetching job
      security:
      - bearerAuth: []
components:
  schemas:
    Jobs:
      type: object
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/Job'
        meta:
          type: object
          properties:
            total:
              type: integer
            limit:
              type: integer
            offset:
              type: integer
    Job:
      type: object
      properties:
        hashed_payload:
          type: string
        updated_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        payload:
          type: object
          properties:
            message:
              type: string
              example: Assembly Webhook test
        webhook_uuid:
          type: string
          format: uuid
        uuid:
          type: string
          format: uuid
        request_responses:
          $ref: '#/components/schemas/RequestResponses'
    RequestResponses:
      type: object
      properties:
        response_code:
          type: string
        Message:
          type: string
        created_at:
          type: string
          format: date-time
    APIResponse:
      type: object
      properties:
        status:
          type: string
        message:
          type: string
  parameters:
    offsetParam:
      name: offset
      in: query
      description: Number of records to offset. Required for pagination.
      required: false
      schema:
        type: integer
        minimum: 0
        default: 0
    limitParam:
      name: limit
      in: query
      description: Number of records to retrieve. Up to 200.
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 10
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-explorer-enabled: false
x-samples-languages:
- curl
- ruby
- php
- javascript
- csharp
- go
x-provenance:
  method: searched
  source: https://developer.hellozai.com/reference
  harvested: '2026-10-22'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.hellozai.com/reference/createsecretkey.md
  - https://developer.hellozai.com/reference/createwebhook.md
  - https://developer.hellozai.com/reference/deletewebhookbyid.md
  - https://developer.hellozai.com/reference/getallwebhooks.md
  - https://developer.hellozai.com/reference/getjob.md
  - https://developer.hellozai.com/reference/getjobs.md
  - https://developer.hellozai.com/reference/getstatus.md
  - https://developer.hellozai.com/reference/getwebhookbyid.md
  - https://developer.hellozai.com/reference/updatewebhook.md
  merge:
    pages: 9
    deduped: 26
    conflicts_kept_first: 0