Phala Network

Phala Network Webhooks API

Manage webhook endpoints and monitor delivery history

Documentation GitHub OpenAPI

Business capability

Webhook & Event Subscription Management BC-4270.80

Operations 11

GET /api/v1/workspace/webhooks List workspace webhooks #

POST /api/v1/workspace/webhooks Create workspace webhook #

GET /api/v1/workspace/webhooks/{webhook_id} Get webhook details #

PUT /api/v1/workspace/webhooks/{webhook_id} Update webhook #

DELETE /api/v1/workspace/webhooks/{webhook_id} Delete webhook #

POST /api/v1/workspace/webhooks/{webhook_id}/reveal-secret Reveal webhook secret (requires 2FA) #

POST /api/v1/workspace/webhooks/{webhook_id}/rotate-secret Rotate webhook secret (requires 2FA) #

POST /api/v1/workspace/webhooks/{webhook_id}/test Send test webhook event #

GET /api/v1/workspace/webhooks/{webhook_id}/deliveries List webhook deliveries #

POST /api/v1/workspace/webhooks/{webhook_id}/deliveries/{event_id}/resend Resend a webhook delivery #

GET /api/v1/workspace/webhooks/{webhook_id}/stats Get webhook delivery stats #

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/phala:phala-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: Phala Cloud Webhooks API
  version: 0.1.0
  description: Manage webhook endpoints and monitor delivery history
servers:
- url: https://cloud-api.phala.com
tags:
- name: Webhooks
  description: Manage webhook endpoints and monitor delivery history
paths:
  /api/v1/workspace/webhooks:
    get:
      tags:
      - Webhooks
      summary: List workspace webhooks
      operationId: list_webhooks_api_v1_workspace_webhooks_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/WebhookResponse'
                type: array
                title: Response List Webhooks Api V1 Workspace Webhooks Get
    post:
      tags:
      - Webhooks
      summary: Create workspace webhook
      operationId: create_webhook_api_v1_workspace_webhooks_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCreateRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workspace/webhooks/{webhook_id}:
    get:
      tags:
      - Webhooks
      summary: Get webhook details
      operationId: get_webhook_api_v1_workspace_webhooks__webhook_id__get
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Webhooks
      summary: Update webhook
      operationId: update_webhook_api_v1_workspace_webhooks__webhook_id__put
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Webhooks
      summary: Delete webhook
      operationId: delete_webhook_api_v1_workspace_webhooks__webhook_id__delete
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workspace/webhooks/{webhook_id}/reveal-secret:
    post:
      tags:
      - Webhooks
      summary: Reveal webhook secret (requires 2FA)
      operationId: reveal_webhook_secret_api_v1_workspace_webhooks__webhook_id__reveal_secret_post
      security:
      - OAuth2AuthorizationCodeBearer: []
      - APIKeyHeader: []
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workspace/webhooks/{webhook_id}/rotate-secret:
    post:
      tags:
      - Webhooks
      summary: Rotate webhook secret (requires 2FA)
      operationId: rotate_webhook_secret_api_v1_workspace_webhooks__webhook_id__rotate_secret_post
      security:
      - OAuth2AuthorizationCodeBearer: []
      - APIKeyHeader: []
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workspace/webhooks/{webhook_id}/test:
    post:
      tags:
      - Webhooks
      summary: Send test webhook event
      operationId: test_webhook_api_v1_workspace_webhooks__webhook_id__test_post
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workspace/webhooks/{webhook_id}/deliveries:
    get:
      tags:
      - Webhooks
      summary: List webhook deliveries
      operationId: list_deliveries_api_v1_workspace_webhooks__webhook_id__deliveries_get
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 50
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebhookDeliveryResponse'
                title: Response List Deliveries Api V1 Workspace Webhooks  Webhook Id  Deliveries Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workspace/webhooks/{webhook_id}/deliveries/{event_id}/resend:
    post:
      tags:
      - Webhooks
      summary: Resend a webhook delivery
      operationId: resend_delivery_api_v1_workspace_webhooks__webhook_id__deliveries__event_id__resend_post
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      - name: event_id
        in: path
        required: true
        schema:
          type: string
          title: Event Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workspace/webhooks/{webhook_id}/stats:
    get:
      tags:
      - Webhooks
      summary: Get webhook delivery stats
      operationId: webhook_stats_api_v1_workspace_webhooks__webhook_id__stats_get
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookStatsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WebhookDeliveryResponse:
      properties:
        snowflake_id:
          type: integer
          title: Snowflake Id
        event_id:
          type: string
          title: Event Id
        event_type:
          type: string
          title: Event Type
        status:
          type: string
          title: Status
        attempts:
          type: integer
          title: Attempts
        request_url:
          type: string
          title: Request Url
        response_status:
          type: integer
          title: Response Status
        error_message:
          type: string
          title: Error Message
        duration_ms:
          type: integer
          title: Duration Ms
          default: 0
        created_at:
          type: string
          format: date-time
          title: Created At
        delivered_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Delivered At
        original_event_id:
          type: string
          title: Original Event Id
          default: ''
      type: object
      required:
      - snowflake_id
      - event_id
      - event_type
      - status
      - attempts
      - request_url
      - response_status
      - error_message
      - created_at
      title: WebhookDeliveryResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WebhookStatsResponse:
      properties:
        total:
          type: integer
          title: Total
        success_count:
          type: integer
          title: Success Count
        failed_count:
          type: integer
          title: Failed Count
        success_rate:
          type: number
          title: Success Rate
        avg_duration_ms:
          type: integer
          title: Avg Duration Ms
        max_duration_ms:
          type: integer
          title: Max Duration Ms
        last_delivery_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Delivery At
      type: object
      required:
      - total
      - success_count
      - failed_count
      - success_rate
      - avg_duration_ms
      - max_duration_ms
      title: WebhookStatsResponse
    WebhookCreateRequest:
      properties:
        url:
          type: string
          title: Url
        events:
          items:
            type: string
          type: array
          title: Events
        name:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: Name
        secret:
          anyOf:
          - type: string
          - type: 'null'
          title: Secret
      type: object
      required:
      - url
      - events
      title: WebhookCreateRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    WebhookResponse:
      properties:
        id:
          type: string
          title: Id
        url:
          type: string
          title: Url
        secret:
          anyOf:
          - type: string
          - type: 'null'
          title: Secret
        events:
          items:
            type: string
          type: array
          title: Events
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        enabled:
          type: boolean
          title: Enabled
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
      - id
      - url
      - events
      - enabled
      - created_at
      - updated_at
      title: WebhookResponse
    WebhookUpdateRequest:
      properties:
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
        events:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Events
        name:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: Name
        enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enabled
      type: object
      title: WebhookUpdateRequest
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: ''
          tokenUrl: token
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
x-provenance:
  method: harvested
  publisher: Phala Network
  source: https://docs.phala.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)