GET Register a signed webhook and verify its receiver
/api/v1/status-pages/{id}/visitors
Authenticated page administration with active-session, ownership, page-role and CSRF checks. Sources, members, domains, delivery rules and whole-page withdrawal require the owner. Editors save drafts; publishers release approved content. version detects parallel edits. Public delivery acknowledges matching publication revisions before publication or revocation is complete.
On this page
Access and permissions
Authenticated page administration with active-session, ownership, page-role and CSRF checks. Sources, members, domains, delivery rules and whole-page withdrawal require the owner. Editors save drafts; publishers release approved content. version detects parallel edits. Public delivery acknowledges matching publication revisions before publication or revocation is complete.
Browser session: __Host-mb_session cookie.
Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.
When using a browser session for a mutation, send the current CSRF token in X-CSRF-Token with the same-site cookie. OAuth consent uses its documented form field.
Parameters and headers
| Field | Location | Type and limits | Required | Meaning |
|---|---|---|---|---|
| id | Path | string; {"format":"uuid"} | Yes | UUID of the status page resource |
| table | URL query | string; {"enum":["1"]} | No | Set to 1 for a filtered cursor page; omitting table parameters preserves the original response. |
| q | URL query | string; {"maxLength":128} | No | Case-insensitive literal search in the documented text fields, applied before the page limit. |
| limit | URL query | integer; {"default":50,"maximum":100,"minimum":1} | No | Page size, 1–100; default 50. A following page exists only when another matching row is available. |
| cursor | URL query | string; {"maxLength":4096} | No | Opaque next_cursor from the preceding page. Keep resource, account, filters, sort and limit unchanged; collection cursors expire after 15 minutes. |
| sort | URL query | string; {"enum":["newest","oldest","name_asc","name_desc"]} | No | Stable order with the record ID as a tie breaker: newest, oldest, name_asc or name_desc. |
| revoked | URL query | string; {"enum":["true","false"]} | No | Exact field filter; omit the parameter to include all values. |
| counts_only | URL query | string; {"enum":["1"]} | No | Return counts for the requested filter instead of table rows. Counts include search and other filters, excluding this filter selection, sorting and pagination. |
| count_filter | URL query | string; {"enum":["revoked"]} | No | Declared table filter to count. Requires counts_only=1. |
| snapshot | URL query | string; {"format":"date-time"} | No | Optional snapshot from the corresponding table page. |
Request body
No request body.
Responses
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object; {"additionalProperties":false} | object | Yes | — |
| $ (anyOf 1) | object; {"additionalProperties":false} | No | — |
| $ (anyOf 1).next_cursor | string | No | — |
| $ (anyOf 1).visitors | array<object; {"additionalProperties":false}> | No | — |
| $ (anyOf 1).visitors[] | object; {"additionalProperties":false} | Yes | — |
| $ (anyOf 1).visitors[].email | string | No | — |
| $ (anyOf 1).visitors[].expires_at | string | null; {"format":"date-time"} | No | — |
| $ (anyOf 1).visitors[].revoked | boolean | No | — |
| $ (anyOf 1).visitors[].sessions | integer | No | — |
| $ (anyOf 2) | object | No | — |
| $ (anyOf 2).filter_counts | TableFilterCounts | Yes | — |
| $ (anyOf 2).filter_counts.field | string | Yes | — |
| $ (anyOf 2).filter_counts.total | integer; {"minimum":0} | Yes | — |
| $ (anyOf 2).filter_counts.values | object | Yes | — |
| $ (anyOf 2).filter_counts.complete | boolean | Yes | — |
| $ (anyOf 2).filter_counts.snapshot | string; {"format":"date-time"} | Yes | — |
| $ (anyOf 2).filter_counts.counted_at | string; {"format":"date-time"} | Yes | — |
| Stable error codes |
|---|
| status_page_operation |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| status_page_operation |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| status_page_operation |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| status_page_operation |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| status_page_operation |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
| Stable error codes |
|---|
| status_page_operation |
| status_pages_disabled |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
Retries and asynchronous work
This change does not have a general retry guarantee. If the response is unclear, read the affected resource before trying again. Follow Retry-After waiting times and request new sign-in or action codes when they expire.
Request examples
Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.
Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.
curl --request POST --cookie '__Host-mb_session=SESSION; __Host-mb_csrf=CSRF' --header 'X-CSRF-Token: CSRF' --header 'Content-Type: application/json' --data '{"endpoint":"https://receiver.customer.example/status","components":["22222222-2222-4222-8222-222222222222"]}' 'https://metribeacon.com/api/v1/status-pages/11111111-1111-4111-8111-111111111111/webhooks'import requests
payload = {'endpoint': 'https://receiver.customer.example/status', 'components': ['22222222-2222-4222-8222-222222222222']}
response = requests.request("POST","https://metribeacon.com/api/v1/status-pages/11111111-1111-4111-8111-111111111111/webhooks",cookies={"__Host-mb_session":"SESSION","__Host-mb_csrf":"CSRF"},headers={"X-CSRF-Token":"CSRF"},json=payload)
response.raise_for_status()const payload = {"endpoint":"https://receiver.customer.example/status","components":["22222222-2222-4222-8222-222222222222"]};
const response = await fetch("https://metribeacon.com/api/v1/status-pages/11111111-1111-4111-8111-111111111111/webhooks", {signal:AbortSignal.timeout(10000),method:"POST",credentials:"same-origin",headers:{"Content-Type":"application/json","X-CSRF-Token":csrf},body:JSON.stringify(payload)});
if (!response.ok) throw new Error(String(response.status));package main
import (
"fmt"
"net/http"
"time"
"strings"
)
func main() {
if err := requestStatus(); err != nil { panic("request failed; credentials and response omitted") }
}
func requestStatus() error {
req, err := http.NewRequest("POST", "https://metribeacon.com/api/v1/status-pages/11111111-1111-4111-8111-111111111111/webhooks", strings.NewReader(`{"endpoint":"https://receiver.customer.example/status","components":["22222222-2222-4222-8222-222222222222"]}`))
if err != nil { return err }
req.AddCookie(&http.Cookie{Name:"__Host-mb_session",Value:"SESSION"})
req.AddCookie(&http.Cookie{Name:"__Host-mb_csrf",Value:"CSRF"})
req.Header.Set("X-CSRF-Token","CSRF")
req.Header.Set("Content-Type","application/json")
client := &http.Client{Timeout: 10*time.Second}
response, err := client.Do(req)
if err != nil { return err }
defer response.Body.Close()
fmt.Println(response.StatusCode)
return nil
}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- POST Register a signed webhook and verify its receiver
Authenticated page administration with active-session, ownership, page-role and CSRF checks. Sources, members, domains, delivery rules and whole-page withdrawal require the owner. Editors save drafts; publishers release approved content. version detects parallel edits. Public delivery acknowledges matching publication revisions before publication or revocation is complete.
- POST Register a signed webhook and verify its receiver
Authenticated page administration with active-session, ownership, page-role and CSRF checks. Sources, members, domains, delivery rules and whole-page withdrawal require the owner. Editors save drafts; publishers release approved content. version detects parallel edits. Public delivery acknowledges matching publication revisions before publication or revocation is complete.
- DELETE Revoke or delete public delivery
Authenticated page administration with active-session, ownership, page-role and CSRF checks. Sources, members, domains, delivery rules and whole-page withdrawal require the owner. Editors save drafts; publishers release approved content. version detects parallel edits. Public delivery acknowledges matching publication revisions before publication or revocation is complete.