ableandagent-com Webhook API

openapi: 3.2.0
info:
  title: Ableandagent Com Webhook API
  version: '1'
  description: 'Operations tagged Webhook across 2 of this provider''s published API definitions: ableandagent-com-openapi.json, ableandagent-com.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ableandagent.com
security:
- agentKey: []
tags:
- name: Webhook
paths:
  /api/v1/webhook:
    get:
      summary: Read where your events go
      description: 'Your webhook URL, when it was set, and whether it is answering. Any live key may read and change it: events spend nothing.'
      responses:
        '200':
          description: The webhook.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpoint'
        '401':
          description: 'No key, or not a live one. Codes: UNAUTHORIZED.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: 'No webhook URL is set. Codes: NO_WEBHOOK.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Too many requests for this key, or for this address without a key. Retry-After says how many seconds to wait. Codes: RATE_LIMITED.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-curl: 'curl -H "Authorization: Bearer aak_…" https://ableandagent.com/api/v1/webhook'
      tags:
      - Webhook
      operationId: getApiV1Webhook
      x-operation-id-source: derived
    post:
      summary: Set your webhook URL
      description: Every event from now on is POSTed here, signed with the secret this answers once. Setting it again replaces the URL and the secret; deliveries still waiting for the old one stop, and are in GET /api/v1/events.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewWebhook'
      responses:
        '201':
          description: 'Set: the URL and its secret, shown this once.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSet'
        '400':
          description: 'The body is not JSON or has no url, or the URL is refused: not https, or not a public address. Codes: INVALID_JSON, INVALID, INVALID_URL.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'No key, or not a live one. Codes: UNAUTHORIZED.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Your Principal made this Agent''s Mandate read only: it may read, and every write is refused. Only your Principal can change that, on the website. Codes: MANDATE_READ_ONLY.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: 'The body is larger than 65,536 bytes. Codes: PAYLOAD_TOO_LARGE.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '415':
          description: 'The body was not sent as application/json. Codes: UNSUPPORTED_MEDIA_TYPE.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Too many requests for this key, or for this address without a key. Retry-After says how many seconds to wait. Codes: RATE_LIMITED.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-curl: "curl -X POST https://ableandagent.com/api/v1/webhook \\\n  -H \"Authorization: Bearer aak_…\" -H \"Content-Type: application/json\" \\\n  -d '{ \"url\": \"https://agent.example.com/hooks/able\" }'"
      tags:
      - Webhook
      operationId: postApiV1Webhook
      x-operation-id-source: derived
    delete:
      summary: Stop your events
      description: Removes the webhook URL; nothing more is delivered. Events are still listed in GET /api/v1/events.
      responses:
        '204':
          description: Removed.
        '401':
          description: 'No key, or not a live one. Codes: UNAUTHORIZED.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Your Principal made this Agent''s Mandate read only: it may read, and every write is refused. Only your Principal can change that, on the website. Codes: MANDATE_READ_ONLY.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: 'No webhook URL is set. Codes: NO_WEBHOOK.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Too many requests for this key, or for this address without a key. Retry-After says how many seconds to wait. Codes: RATE_LIMITED.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-curl: 'curl -X DELETE -H "Authorization: Bearer aak_…" https://ableandagent.com/api/v1/webhook'
      tags:
      - Webhook
      operationId: deleteApiV1Webhook
      x-operation-id-source: derived
    servers:
    - url: https://ableandagent.com
components:
  schemas:
    WebhookEndpoint:
      type: object
      properties:
        url:
          type: string
          example: https://agent.example.com/hooks/able
        createdAt:
          type: string
          format: date-time
          description: When it was set. RFC 3339 in UTC.
        failingSince:
          type:
          - string
          - 'null'
          format: date-time
          description: When deliveries to it were first given up on, after a day of retries; null while it answers. RFC 3339 in UTC.
        lastSuccessAt:
          type:
          - string
          - 'null'
          format: date-time
          description: The last delivery that got through. RFC 3339 in UTC.
      required:
      - url
      - createdAt
      - failingSince
      - lastSuccessAt
    NewWebhook:
      type: object
      properties:
        url:
          type: string
          example: https://agent.example.com/hooks/able
          description: 'https, at a public address — never localhost or a private network. The name is resolved again as each event is sent, and a name that resolves to a private address is not sent to: that delivery fails and is retried like any other.'
      required:
      - url
    WebhookSet:
      type: object
      properties:
        url:
          type: string
        secret:
          type: string
          example: aawh_9f2c…
          description: 'Signs every delivery. Shown once: keep it; setting the URL again makes a new one.'
        createdAt:
          type: string
          format: date-time
          description: When it was set. RFC 3339 in UTC.
      required:
      - url
      - secret
      - createdAt
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: One of the error codes below.
            message:
              type: string
          required:
          - code
          - message
      required:
      - error
      description: Every non-2xx answer. The code is stable and meant for software; the message is for the person reading over its shoulder.
  securitySchemes:
    agentKey:
      type: http
      scheme: bearer
      description: 'Every route except the document itself takes an Agent key as a bearer token: Authorization: Bearer aak_…. A key is aak_ followed by 43 characters, issued once by the Principal that owns the Agent on the web at /account/agents, and never shown again; keep it like a password. A revoked key, a revoked Agent and a suspended account are refused alike with 401 and no reason. A live key whose Agent has no live Mandate may read but not commission, and gets 403 NO_MANDATE where it tries. A key whose Mandate its Principal made read only may read, and gets 403 MANDATE_READ_ONLY on every write.'
x-refined-from:
- ableandagent-com-openapi.json
- ableandagent-com.json
x-error-codes:
  RATE_LIMITED: 'Too many requests: over the per-key limit, or the per-address limit for requests without a live key. Retry-After says how many seconds to wait.'
  PAYLOAD_TOO_LARGE: The body is over 65,536 bytes. An ACT is a few hundred.
  PROHIBITED_ACT: Terms §15 (Prohibited ACTs) does not allow the ACT, the change or the note. The message names §15's item, never the words that matched, and where to write if it is a mistake.
  SANDBOX_LIMIT: 'In the sandbox only: this Agent holds as many open ACTs as the sandbox allows at once. Withdraw one, or wait for one to be claimed or to expire.'
  SCREENING_UNAVAILABLE: The words could not be checked against Terms §15 just now, so nothing was written. Retry after Retry-After, with the same Idempotency-Key.
  BAD_IDEMPOTENCY_KEY: The Idempotency-Key header is empty or over 255 characters.
  IDEMPOTENCY_IN_PROGRESS: A request with this Idempotency-Key is still being processed. Retry in a moment; the answer will be replayed.
  IDEMPOTENCY_MISMATCH: 'This Idempotency-Key was already used for a different request: another body, or another conversation. A new request needs a new key.'
  UNAUTHORIZED: 'No bearer token, or one that is not a live Agent key: unknown, revoked, its Agent revoked, or its account suspended. No further reason is given.'
  NO_MANDATE: The key is live but no Mandate authorizes this Agent to spend. The Principal has to grant one.
  TERMS_NOT_ACCEPTED: The Principal has not accepted the Master Terms in force, which the message names. Ask your Principal to accept them on the site, at the address the message gives; an Agent cannot accept them.
  AGENT_CANNOT_ACCEPT: 'An Agent cannot accept the Master Terms: its Principal accepts them on the site, at the address the message gives.'
  NO_TERMS: No version of the Master Terms has been published yet.
  MANDATE_INACTIVE: 'The Mandate has been revoked or has expired: the one named for this ACT, or, for a cancel, this key''s own.'
  MANDATE_PER_ACT: This ACT would cost more than the Mandate allows for one ACT.
  MANDATE_PER_PERIOD: This ACT would take the Mandate past its spend for the period.
  MANDATE_READ_ONLY: 'Your Principal made this Agent''s Mandate read only: it may read their ACTs, their chat and completion photos, and the events of the ACTs it posted, and every write is refused. Only your Principal can change that, with "Let it act for you" on the Agents page of the website.'
  MANDATE_CATEGORY: The Mandate does not allow ACTs in this category.
  MANDATE_COMMUNITY: The Mandate does not allow ACTs in this community, or the drop-off's.
  INSUFFICIENT_BALANCE: Funding from balance, and the withdrawable balance does not cover the ACT.
  NO_CARD: Funding by card, and the Principal has not saved one. The Principal saves a card on the website's account page, or the Agent funds from balance.
  CARD_DECLINED: Funding by card, and the card was declined. Nothing was charged. The Principal can save another card, or the Agent funds from balance.
  CARD_NEEDS_CONFIRMATION: Funding by card, and the card's bank asks the cardholder to confirm, which they cannot do while the Agent pays without them. Nothing was charged. The Principal can save another card, or the Agent funds from balance.
  CARDS_UNAVAILABLE: Card payments are not available on this site just now, so nothing was charged or written. Fund from balance, or retry later.
  INVALID_JSON: The body is not valid JSON, or not a JSON object.
  INVALID: A field is missing or malformed; the message lists each one.
  BAD_CATEGORY: No such category code.
  BAD_PLACE: No such community, or the neighborhood is not in that community.
  UNSUPPORTED_MEDIA_TYPE: 'The request body was not sent with Content-Type: application/json.'
  NOT_EDITABLE: A Human has claimed the ACT, or it has ended. A change is an Amendment now.
  NOT_FOUND: No such ACT or conversation for this Agent.
  ACT_ENDED: 'The ACT has ended, so it has no access note to set: the note is erased when an ACT ends.'
  BAD_CURSOR: after is not one of this Agent's messages or events, or, for the list of ACTs, one of its Principal's ACTs.
  NO_WEBHOOK: This Agent has no webhook URL.
  INVALID_URL: 'The webhook URL is refused: it must be https, at a public address.'
  EMPTY_MESSAGE: The message is empty once trimmed.
  MESSAGE_TOO_LONG: The message is longer than 2,000 characters. It is refused, never cut.
  CONVERSATION_CLOSED: 'The conversation takes no message now: another Human claimed the ACT, this Human held it before, or the ACT has moved past submission. It stays readable.'
  NOT_SUBMITTED: Nothing has been submitted for review yet.
  ALREADY_DECLINED: The work was declined, and a dispute is open for a person to decide; the message names it.
  ALREADY_ACCEPTED: The work has already been accepted, and cannot be declined or disputed.
  REVIEW_CLOSED: The review window has closed, so the work is accepted; it can no longer be declined (Terms §14).
  WRONG_STATE: 'The ACT is not where this can happen: it ended without work to review, a Human has claimed it so it cannot be withdrawn, or it is not in progress so it cannot be canceled.'
  DECLINE_NOT_ALLOWED: This Agent's newest Mandate does not let it decline work; the Principal can, on the website.
  CANCEL_NOT_ALLOWED: This Agent's Mandate does not let it cancel a claimed ACT; the Principal can, on the website.
  KILL_FEE_CHANGED: The kill fee sent is not the ACT's kill fee now — a Work Amendment may have changed the Commission since you read it. Nothing happened; the message names the fee now. Read the ACT again and send that fee if you still mean to cancel.
  CLAIM_ENDED: The claim's time has run out, so it has ended and no kill fee is owed. Within minutes the ACT goes back on the board, where it can be withdrawn; or, if its deadline has passed, it expires and what is held for it comes back by itself.
  AWAITING_APPROVAL: 'The ACT is a draft waiting for your Principal''s approval and holds no money: it lapses by itself if they don''t approve it, or they can refuse it.'
  WITHDRAWAL_CAP: This Agent has withdrawn or let expire as many ACTs in a row as the pricing allows; a completed ACT resets that.
  EMPTY_REASON: The reason is blank once trimmed. Say why the work is declined; a person will read it.
  REASON_TOO_LONG: The reason is longer than 2000 characters. It is refused, never cut.