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/buildworkpro-com:buildworkpro-com-webhooks-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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:
  title: BuildWorkPro Webhooks API
  version: 1.0.0
  description: Construction project management, CRM, and workflows — public REST API.
  contact:
    name: BuildWorkPro Developers
    email: developers@buildworkpro.com
  license:
    name: Proprietary
    url: https://buildworkpro.com/terms
servers:
- url: https://app.buildworkpro.com/api/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Webhooks
  description: Outbound webhook endpoints and their delivery history.
paths:
  /webhook-endpoints:
    get:
      summary: List webhook endpoints
      description: Returns all active webhook endpoints for the tenant (capped at 200, no cursor pagination yet). The signingSecret field is never returned here — it is only surfaced once on creation and once on rotation.
      security:
      - bearerAuth:
        - webhooks:manage
      tags:
      - Webhooks
      responses:
        '200':
          description: Endpoints
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookEndpoint'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '403':
          description: Scope insufficient
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getWebhookEndpoints
      x-rate-limit-cost: 1
    post:
      summary: Create webhook endpoint
      description: Creates a new webhook endpoint. The url is SSRF-validated before creation. The signingSecret is returned in the response exactly once — store it now, it cannot be retrieved later.
      security:
      - bearerAuth:
        - webhooks:manage
      tags:
      - Webhooks
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  minLength: 1
                eventTypes:
                  type: array
                  items:
                    type: string
                    enum:
                    - bid.created
                    - bid.updated
                    - bid.deleted
                    - bid.accepted
                    - bid.acceptance_reverted
                    - bid.rejected
                    - bid.expired
                    - bid.cancelled
                    - bid.reopened
                    - project.created
                    - project.updated
                    - project.deleted
                    - project.status_changed
                    - pay_app.submitted
                    - pay_app.approved
                    - pay_app.rejected
                    - pay_app.paid
                    - pay_app.voided
                    - pay_app.updated
                    - pay_app.deleted
                    - change_order.submitted
                    - change_order.approved
                    - change_order.rejected
                    - change_order.voided
                    - change_order.updated
                    - change_order.deleted
                    - contact.created
                    - contact.updated
                    - contact.deleted
                    - lead.created
                    - lead.updated
                    - lead.deleted
                    - product.created
                    - product.updated
                    - product.deleted
                  minItems: 1
                  maxItems: 35
                description:
                  type:
                  - string
                  - 'null'
                  maxLength: 2000
              required:
              - url
              - eventTypes
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WebhookEndpointWithSecret'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '422':
          description: Validation failed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: postWebhookEndpoints
      x-rate-limit-cost: 5
  /webhook-endpoints/{id}:
    get:
      summary: Get webhook endpoint
      description: Returns a single webhook endpoint. The signingSecret field is redacted.
      security:
      - bearerAuth:
        - webhooks:manage
      tags:
      - Webhooks
      parameters:
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Endpoint
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WebhookEndpoint'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getWebhookEndpointsById
      x-rate-limit-cost: 1
    patch:
      summary: Update webhook endpoint
      description: Partially updates a webhook endpoint. If url changes, it is re-validated against SSRF rules. The signingSecret is never returned.
      security:
      - bearerAuth:
        - webhooks:manage
      tags:
      - Webhooks
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - schema:
          type: integer
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  minLength: 1
                eventTypes:
                  type: array
                  items:
                    type: string
                    enum:
                    - bid.created
                    - bid.updated
                    - bid.deleted
                    - bid.accepted
                    - bid.acceptance_reverted
                    - bid.rejected
                    - bid.expired
                    - bid.cancelled
                    - bid.reopened
                    - project.created
                    - project.updated
                    - project.deleted
                    - project.status_changed
                    - pay_app.submitted
                    - pay_app.approved
                    - pay_app.rejected
                    - pay_app.paid
                    - pay_app.voided
                    - pay_app.updated
                    - pay_app.deleted
                    - change_order.submitted
                    - change_order.approved
                    - change_order.rejected
                    - change_order.voided
                    - change_order.updated
                    - change_order.deleted
                    - contact.created
                    - contact.updated
                    - contact.deleted
                    - lead.created
                    - lead.updated
                    - lead.deleted
                    - product.created
                    - product.updated
                    - product.deleted
                  minItems: 1
                  maxItems: 35
                description:
                  type:
                  - string
                  - 'null'
                  maxLength: 2000
                isActive:
                  type: boolean
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WebhookEndpoint'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: Validation failed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: patchWebhookEndpointsById
      x-rate-limit-cost: 5
    delete:
      summary: Delete webhook endpoint
      description: Soft-deletes a webhook endpoint. Future events will not be delivered.
      security:
      - bearerAuth:
        - webhooks:manage
      tags:
      - Webhooks
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '204':
          description: Deleted
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: deleteWebhookEndpointsById
      x-rate-limit-cost: 5
  /webhook-endpoints/{id}/rotate-secret:
    post:
      summary: Rotate webhook signing secret
      description: Generates a new signing secret for the endpoint and returns it in the response. The old secret is invalidated immediately. Surface this value once and store it securely.
      security:
      - bearerAuth:
        - webhooks:manage
      tags:
      - Webhooks
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Rotated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      signingSecret:
                        type: string
                    required:
                    - signingSecret
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: postWebhookEndpointsByIdRotateSecret
      x-rate-limit-cost: 5
  /webhook-endpoints/{id}/deliveries:
    get:
      summary: List recent deliveries for an endpoint
      description: Returns the 100 most recent webhook delivery rows for the endpoint, ordered most-recent-first. When more exist, meta.pagination.has_more is true and cursor stays null — page the rest with GET /webhook-deliveries.
      security:
      - bearerAuth:
        - webhooks:manage
      tags:
      - Webhooks
      parameters:
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Deliveries
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookDelivery'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      operationId: getWebhookEndpointsByIdDeliveries
      x-rate-limit-cost: 1
  /webhook-deliveries:
    get:
      operationId: listWebhookDeliveries
      summary: List webhook deliveries (tenant-wide)
      description: Returns cursor-paginated webhook delivery rows for the calling tenant across all endpoints. Filterable by endpoint, status, event type, and createdAt date range. The per-endpoint list is capped at 100 and sets has_more when that cap is hit; use this endpoint to page further.
      security:
      - bearerAuth:
        - webhooks:manage
      tags:
      - Webhooks
      parameters:
      - schema:
          type: integer
          minimum: 1
          maximum: 100
        required: false
        name: limit
        in: query
      - schema:
          type: string
        required: false
        name: cursor
        in: query
      - schema:
          type: integer
          minimum: 1
        required: false
        name: endpointId
        in: query
      - schema:
          type: string
          enum:
          - pending
          - succeeded
          - failed
          - exhausted
        required: false
        name: status
        in: query
      - schema:
          type: string
        required: false
        name: eventType
        in: query
      - schema:
          type: string
          format: date-time
        required: false
        name: dateFrom
        in: query
      - schema:
          type: string
          format: date-time
        required: false
        name: dateTo
        in: query
      responses:
        '200':
          description: Deliveries page
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookDeliveryFull'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '400':
          description: Bad request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Scope insufficient
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      x-rate-limit-cost: 1
  /webhook-deliveries/{id}:
    get:
      operationId: getWebhookDelivery
      summary: Get webhook delivery
      description: Returns a single webhook delivery row, including the response body (capped at 10KB) and headers captured from the most recent attempt.
      security:
      - bearerAuth:
        - webhooks:manage
      tags:
      - Webhooks
      parameters:
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Delivery
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WebhookDeliveryFull'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      x-rate-limit-cost: 1
  /webhook-deliveries/{id}/replay:
    post:
      operationId: replayWebhookDelivery
      summary: Replay webhook delivery
      description: Re-enqueues the delivery for another delivery attempt. The attemptCount is reset to 0, status is set back to pending, and the response/error fields are cleared. Returns 409 if the linked endpoint has been soft-deleted.
      security:
      - bearerAuth:
        - webhooks:manage
      tags:
      - Webhooks
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - schema:
          type: integer
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Replayed
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WebhookDeliveryFull'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                - data
                - meta
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: Endpoint deleted
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      x-rate-limit-cost: 5
components:
  schemas:
    WebhookEndpointWithSecret:
      allOf:
      - $ref: '#/components/schemas/WebhookEndpoint'
      - type: object
        properties:
          signingSecret:
            type: string
        required:
        - signingSecret
    PaginationMeta:
      type: object
      properties:
        cursor:
          type:
          - string
          - 'null'
          description: Opaque cursor for the next page; null when no more results
        has_more:
          type: boolean
          description: Whether more pages are available after this one
        count:
          type: integer
          description: Items in this page
      required:
      - cursor
      - has_more
      - count
    WebhookDeliveryFull:
      type: object
      properties:
        id:
          type: integer
        eventId:
          type: string
        endpointId:
          type: integer
        status:
          type: string
          enum:
          - pending
          - succeeded
          - failed
          - exhausted
        attemptCount:
          type: integer
        nextAttemptAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
        lastAttemptedAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
        responseStatus:
          type:
          - integer
          - 'null'
        responseBody:
          type:
          - string
          - 'null'
        responseHeaders:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
        errorMessage:
          type:
          - string
          - 'null'
        createdAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
        completedAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
      required:
      - id
      - eventId
      - endpointId
      - status
      - attemptCount
      - nextAttemptAt
      - lastAttemptedAt
      - responseStatus
      - responseBody
      - responseHeaders
      - errorMessage
      - createdAt
      - completedAt
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: URL identifying the problem type
        title:
          type: string
          description: Short human-readable summary
        status:
          type: integer
          description: HTTP status code
        detail:
          type: string
          description: Human-readable explanation
        request_id:
          type: string
          description: Server-generated request identifier
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
                description: Field path that failed validation
              code:
                type: string
                description: Validation error code
              message:
                type: string
                description: Human-readable validation message
            required:
            - field
            - code
            - message
          description: Validation error array (422 only)
      required:
      - type
      - title
      - status
    ResponseMeta:
      type: object
      properties:
        request_id:
          type: string
          description: Server-generated request identifier
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
    WebhookDelivery:
      type: object
      properties:
        id:
          type: integer
        eventId:
          type: string
        endpointId:
          type: integer
        status:
          type: string
          enum:
          - pending
          - succeeded
          - failed
          - exhausted
        attemptCount:
          type: integer
        nextAttemptAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
        lastAttemptedAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
        responseStatus:
          type:
          - integer
          - 'null'
        responseBody:
          type:
          - string
          - 'null'
        responseHeaders:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
        errorMessage:
          type:
          - string
          - 'null'
        createdAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
        completedAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
      required:
      - id
      - eventId
      - endpointId
      - status
      - attemptCount
      - nextAttemptAt
      - lastAttemptedAt
      - responseStatus
      - responseBody
      - responseHeaders
      - errorMessage
      - createdAt
      - completedAt
    WebhookEndpoint:
      type: object
      properties:
        id:
          type: integer
        url:
          type: string
        description:
          type:
          - string
          - 'null'
        eventTypes:
          type: array
          items:
            type: string
        isActive:
          type: boolean
        consecutiveFailures:
          type: integer
        lastDeliveredAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
        disabledAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
        disabledReason:
          type:
          - string
          - 'null'
        createdAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
        updatedAt:
          anyOf:
          - type: string
            format: date-time
          - type: string
      required:
      - id
      - url
      - description
      - eventTypes
      - isActive
      - consecutiveFailures
      - lastDeliveredAt
      - disabledAt
      - disabledReason
      - createdAt
      - updatedAt
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: 'Idempotent retry key for mutating operations. The first request with a given key executes normally and BuildWorkPro caches the response. Replaying the same key with the same request body (method + path + JSON body, SHA-256 hashed) returns the cached response without re-executing the mutation. Replaying with a DIFFERENT body returns `409 idempotency_key_reused`. The cache TTL is 24 hours; after expiry the key is treated as a new operation. Keys are tenant-scoped. Recommended: a fresh UUID v4 per logical operation.'
      schema:
        type: string
        format: uuid
        maxLength: 255
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bwp_live_... or bwp_test_...
      description: Long-lived tenant-wide API key. Provision in Settings → Developer → API Keys.
    oauth2:
      type: oauth2
      description: OAuth 2.1 per-user token. Available in Phase 4.
      flows:
        authorizationCode:
          authorizationUrl: https://app.buildworkpro.com/api/v1/oauth/authorize
          tokenUrl: https://app.buildworkpro.com/api/v1/oauth/token
          refreshUrl: https://app.buildworkpro.com/api/v1/oauth/token
          scopes: {}