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/mabl:mabl-executionnotification-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: mabl Execution Notification API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: ExecutionNotification
paths:
  /executionNotifications:
    get:
      tags:
      - ExecutionNotification
      summary: Query Execution Notifications
      description: Query all or a subset of Execution Notifications
      operationId: queryExecutionNotifications
      parameters:
      - name: workspace_id
        in: query
        description: Associated Workspace identifier
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: notification_type
        in: query
        description: Filter
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - webhook
          - email
      - name: lifecycle_trigger,
        in: query
        description: Filter
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Pagination limit
        required: false
        style: form
        explode: true
        schema:
          minimum: 1
          type: integer
          format: int32
          default: 20
      - name: cursor
        in: query
        description: Pagination cursor
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Query result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionNotificationQueryResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Workspace not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::ExecutionNotification
    post:
      tags:
      - ExecutionNotification
      summary: Create Execution Notification
      operationId: createExecutionNotification
      requestBody:
        description: Execution Notification details
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecutionNotification'
        required: true
      responses:
        '201':
          description: Created ExecutionNotification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionNotification'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Execution Notification not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Create::ExecutionNotification
  /executionNotifications/{id}:
    get:
      tags:
      - ExecutionNotification
      summary: Get Execution Notification
      description: Get specific Execution Notification
      operationId: getExecutionNotification
      parameters:
      - name: id
        in: path
        description: Execution Notification identifier
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Matching Execution Notification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionNotification'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Execution Notification not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::ExecutionNotification
    delete:
      tags:
      - ExecutionNotification
      summary: Remove Execution Notification
      description: Remove specific Execution Notification
      operationId: removeExecutionNotification
      parameters:
      - name: id
        in: path
        description: Execution Notification identifier
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: Successful removal
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Delete::ExecutionNotification
    patch:
      tags:
      - ExecutionNotification
      summary: Update Execution Notification
      description: Update partial Execution Notification information. Notification type, tags and plan associations are fixed at creation and are ignored here.
      operationId: updateExecutionNotification
      parameters:
      - name: id
        in: path
        description: Execution Notification identifier
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: If-Match
        in: header
        description: If-Match header according to http/1.1 spec section 14.24
        required: false
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Execution Notification fields to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecutionNotification'
        required: true
      responses:
        '200':
          description: Updated Execution Notification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionNotification'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Execution Notification not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::ExecutionNotification
components:
  responses:
    ErrorResponse401:
      description: User not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse400:
      description: Invalid or missing parameter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse403:
      description: User not authorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse:
      description: Unknown error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
  schemas:
    GuardrailApprovalKind:
      type: string
      description: Who decides a guardrail approval. SELF is decided by the person the agent acts for; WORKSPACE, for an agent acting for an API key, by a workspace owner or editor.
      enum:
      - SELF
      - WORKSPACE
    GuardrailRefusal:
      type: object
      properties:
        id:
          type: string
          description: The id of the guardrail policy that decided the refusal.
        reason:
          type: string
          description: Why the policy refuses the request, written for the person the agent acts for.
        decision_id:
          type: string
          description: The id of this decision in the guardrail decision log.
        action:
          type: string
          description: The action the request was evaluated as, written Verb::Resource (for example Delete::Test), as declared by the operation's x-mabl-action extension.
        policy_source:
          type: string
          description: 'Who set the deciding policy: workspace for a rule the workspace''s owners wrote, account for a rule set for the workspace''s account, mabl_agent_type for the agent type''s ceiling, and mabl_default for mabl''s own defaults.'
        approval:
          description: The approval for this request; present when error_code is approval_required and the approval could be recorded. Without it the request cannot be approved.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalRef'
      description: The guardrail policy that refused an agent request.
    ExecutionNotification:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier
        created_time:
          type: integer
          description: Creation time, epoch milliseconds GMT
          format: int64
        created_by_id:
          type: string
          description: Creation User identifier
        last_updated_time:
          type: integer
          description: Last update time, epoch milliseconds GMT
          format: int64
        last_updated_by_id:
          type: string
          description: Last updated User identifier
        workspace_id:
          type: string
          description: Associated Organization identifier
        enabled:
          type: boolean
          description: Enabled state, true to use Notification on Plan Execution. Defaults to true
        notification_type:
          type: string
          description: Notification type
          enum:
          - webhook
          - email
        lifecycle_triggers:
          type: array
          description: Triggering events in Plan Execution lifecycle [pre_execution, post_execution]
          items:
            type: string
        execution_outcome_triggers:
          type: array
          description: Triggering Plan Execution outcomes [on_success, on_failure]
          items:
            type: string
        execution_contingent:
          type: boolean
          description: If true, Plan Execution continues if notification successful (only for pre_execution). Defaults to false
        strict_tls:
          type: boolean
          description: If true, require strict validation of all TLS connections. Defaults to true
        name:
          maxLength: 1024
          type: string
          description: Display name
        target_url:
          maxLength: 2048
          type: string
          description: Endpoint URL to receive POST payload, starting with protocol (e.g. https://)
        target_email:
          maxLength: 256
          type: string
          description: Email address to receive execution notification
        plan_ids:
          maxItems: 5
          type: array
          description: Plans associated with Notification, if empty, applies to all Workspace Plans
          items:
            type: string
        tags:
          type: array
          description: Free text tags associated with entity
          items:
            $ref: '#/components/schemas/Tag'
        http_headers:
          maxItems: 20
          type: array
          description: Custom HTTP headers to send with the outgoing webhook request. Values are stored encrypted and are returned only when fetching a single notification by id; they are omitted from query results. Names must be RFC 7230 tokens and values printable ASCII. Headers mabl sets itself, the hop-by-hop framing headers, and the headers the cloud metadata server answers to cannot be set.
          items:
            $ref: '#/components/schemas/HttpHeader'
      description: Notification associated with Plan Execution lifecycle
      x-implements-interface:
      - ActivityTrackingBaseEntity
      - HasWorkspaceId
      - HasName
    GuardrailApprovalState:
      type: string
      description: Where a guardrail approval stands. PENDING awaits a decision and expires undecided after 24 hours; APPROVED lets the agent repeat the request, as often as it does, for 20 minutes; DENIED refuses the same request for 20 minutes after the decision, after which asking again opens a new approval; CANCELLED means a person withdrew it while pending or revoked it while approved. EXPIRED and CANCELLED are final.
      enum:
      - PENDING
      - APPROVED
      - DENIED
      - EXPIRED
      - CANCELLED
    Tag:
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: tag name
          x-mabl-scope: public
        values:
          maxItems: 32
          minItems: 0
          type: array
          items:
            type: string
    GuardrailApprovalRef:
      type: object
      properties:
        id:
          type: string
          description: The approval's id.
        state:
          description: Where the approval stands.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalState'
        kind:
          description: Who decides the approval.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalKind'
        request_expires_time:
          type: integer
          description: When the approval expires if nobody decides it, in epoch milliseconds.
          format: int64
        url:
          type: string
          description: The mabl app page where a person reviews the approval.
      description: 'An approval a guardrail policy asks for. While it is PENDING, stop: give the person the url, tell them the request is waiting for approval, and do not repeat the request or poll in a loop. Once a person tells you it is APPROVED, repeat the identical request with the header X-Mabl-Approval set to id. DENIED means a person said no, so do not work around it.'
    ErrorResponseGeneric:
      type: object
      properties:
        id:
          type: string
          x-mabl-scope: public
        code:
          maximum: 599
          minimum: 100
          type: integer
          format: int32
          x-mabl-scope: public
        message:
          type: string
          x-mabl-scope: public
        error_code:
          type: string
          description: Machine-readable reason for the error, present only when the API names one. Values are guardrail_blocked (a guardrail policy refused an agent request), approval_required (a guardrail policy requires a person to approve the request first).
        guardrail:
          description: The guardrail policy that refused the request; present only when error_code is guardrail_blocked or approval_required.
          allOf:
          - $ref: '#/components/schemas/GuardrailRefusal'
    HttpHeader:
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: The name of the header
          x-mabl-scope: public
        value:
          type: string
          description: The value of the header
          x-mabl-scope: public
        log_header_value:
          type: boolean
          description: Log the header value in the execution log, if not true only the header name is logged.
          x-mabl-scope: public
      description: An HTTP header
    ExecutionNotificationQueryResult:
      type: object
      properties:
        execution_notifications:
          type: array
          description: Matching Execution Notifications
          readOnly: true
          items:
            $ref: '#/components/schemas/ExecutionNotification'
        cursor:
          type: string
          description: Pagination cursor
          readOnly: true
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header