Admin Webhooks

Generated admin webhooks operations.

GET/v1/admin/webhooksList webhooks and the events they can be sentadmin

Audience: Integrations · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: list_webhooks

Responses

200Successapplication/json

Example

{
  "events": [
    "string"
  ],
  "items": [
    {
      "createdAt": "2026-10-18T19:30:00Z",
      "dropped": 0,
      "enabled": true,
      "events": [
        "string"
      ],
      "failing": 0,
      "id": "id_8h2k4q",
      "name": "Fargo",
      "requiresOwnerReview": true,
      "revision": 0,
      "secretHint": "string",
      "updatedAt": "2026-10-18T19:30:00Z",
      "url": "https://example.com/…",
      "waiting": 0
    }
  ],
  "maximum": 0
}

Schema

eventsarray of stringrequired
itemsarray of objectrequired
- createdAtstringrequired
- droppedintegerrequired
- enabledbooleanrequired
- eventsarray of stringrequired
- failingintegerrequired
- idstringrequired
- namestringrequired
- requiresOwnerReviewboolean
- revisionintegerrequired
- secretHintstringrequired
- updatedAtstringrequired
- urlstringrequired
- waitingintegerrequired
maximumintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinsufficient_scopeinvalid_requestadministration_unavailableinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/webhooks" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/admin/webhooksAdd a webhook; its signing secret is shown onceadmin

Audience: Integrations · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: create_webhook
Max body: 8 KiB

Request body application/json · required

Example

{
  "enabled": true,
  "events": [
    "string"
  ],
  "name": "Fargo",
  "operationId": "id_8h2k4q",
  "secret": "string",
  "url": "https://example.com/…"
}

Schema

enabledboolean
eventsarray of stringrequired
namestringrequired
operationIdstring
secretstring
urlstringrequired

Responses

201Successapplication/json

Example

{
  "secret": "string",
  "webhook": {
    "createdAt": "2026-10-18T19:30:00Z",
    "dropped": 0,
    "enabled": true,
    "events": [
      "string"
    ],
    "failing": 0,
    "id": "id_8h2k4q",
    "name": "Fargo",
    "requiresOwnerReview": true,
    "revision": 0,
    "secretHint": "string",
    "updatedAt": "2026-10-18T19:30:00Z",
    "url": "https://example.com/…",
    "waiting": 0
  }
}

Schema

secretstring
webhookobjectrequired
- createdAtstringrequired
- droppedintegerrequired
- enabledbooleanrequired
- eventsarray of stringrequired
- failingintegerrequired
- idstringrequired
- namestringrequired
- requiresOwnerReviewboolean
- revisionintegerrequired
- secretHintstringrequired
- updatedAtstringrequired
- urlstringrequired
- waitingintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codeswebhook_limitbody_too_largeidempotency_key_reusednot_foundunauthorizednot_permittedinsufficient_scopeinvalid_requestadministration_unavailableinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/webhooks" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"events":["string"],"name":"Fargo","operationId":"id_8h2k4q","secret":"string","url":"https://example.com/…"}'

DELETE/v1/admin/webhooks/{id}Remove a webhook with its queue and its logadmin

Audience: Integrations · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: delete_webhook

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesnot_foundunauthorizednot_permittedinsufficient_scopeinvalid_requestadministration_unavailableinternaldatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/admin/webhooks/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/webhooks/{id}Read one webhookadmin

Audience: Integrations · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_webhook

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

200Successapplication/json

Example

{
  "createdAt": "2026-10-18T19:30:00Z",
  "dropped": 0,
  "enabled": true,
  "events": [
    "string"
  ],
  "failing": 0,
  "id": "id_8h2k4q",
  "name": "Fargo",
  "requiresOwnerReview": true,
  "revision": 0,
  "secretHint": "string",
  "updatedAt": "2026-10-18T19:30:00Z",
  "url": "https://example.com/…",
  "waiting": 0
}

Schema

createdAtstringrequired
droppedintegerrequired
enabledbooleanrequired
eventsarray of stringrequired
failingintegerrequired
idstringrequired
namestringrequired
requiresOwnerReviewboolean
revisionintegerrequired
secretHintstringrequired
updatedAtstringrequired
urlstringrequired
waitingintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesnot_foundunauthorizednot_permittedinsufficient_scopeinvalid_requestadministration_unavailableinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/webhooks/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PATCH/v1/admin/webhooks/{id}Change a webhook, turn it on or off, or replace its secret; fenced by its revisionadmin

Audience: Integrations · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: update_webhook
Max body: 8 KiB

Parameters

Name	In	Type	Description
`id`required	path	`string`

Request body application/json · required

Example

{
  "enabled": true,
  "events": [
    "string"
  ],
  "expectedRevision": 0,
  "name": "Fargo",
  "rotateSecret": true,
  "secret": "string",
  "url": "https://example.com/…"
}

Schema

enabledboolean
eventsarray of string
expectedRevisionintegerrequired
namestring
rotateSecretboolean
secretstring
urlstring

Responses

200Successapplication/json

Example

{
  "secret": "string",
  "webhook": {
    "createdAt": "2026-10-18T19:30:00Z",
    "dropped": 0,
    "enabled": true,
    "events": [
      "string"
    ],
    "failing": 0,
    "id": "id_8h2k4q",
    "name": "Fargo",
    "requiresOwnerReview": true,
    "revision": 0,
    "secretHint": "string",
    "updatedAt": "2026-10-18T19:30:00Z",
    "url": "https://example.com/…",
    "waiting": 0
  }
}

Schema

secretstring
webhookobjectrequired
- createdAtstringrequired
- droppedintegerrequired
- enabledbooleanrequired
- eventsarray of stringrequired
- failingintegerrequired
- idstringrequired
- namestringrequired
- requiresOwnerReviewboolean
- revisionintegerrequired
- secretHintstringrequired
- updatedAtstringrequired
- urlstringrequired
- waitingintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesbody_too_largerevision_mismatchnot_foundunauthorizednot_permittedinsufficient_scopeinvalid_requestadministration_unavailableinternalrevision_requireddatabase_busywriter_capacity

Example request

curl -X PATCH "http://127.0.0.1:32500/v1/admin/webhooks/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"events":["string"],"expectedRevision":0,"name":"Fargo","rotateSecret":true,"secret":"string","url":"https://example.com/…"}'

GET/v1/admin/webhooks/{id}/deliveriesRead a webhook's delivery log, newest firstadmin

Audience: Integrations · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: list_webhook_deliveries

Parameters

Name	In	Type
`id`required	path	`string`
`cursor`	query	`string`
`limit`	query	`integer \| ""`1–100

Responses

200Successapplication/json

Example

{
  "items": [
    {
      "attempts": 0,
      "createdAt": "2026-10-18T19:30:00Z",
      "durationMs": 1800000,
      "error": "string",
      "event": "string",
      "finishedAt": "2026-10-18T19:30:00Z",
      "id": "id_8h2k4q",
      "nextAttemptAt": "2026-10-18T19:30:00Z",
      "state": "string",
      "status": 0
    }
  ],
  "limit": 0,
  "nextCursor": "eyJvIjoyMH0"
}

Schema

itemsarray of objectrequired
- attemptsintegerrequired
- createdAtstringrequired
- durationMsintegerrequired
- errorstring
- eventstringrequired
- finishedAtstring
- idstringrequired
- nextAttemptAtstring
- statestringrequired
- statusintegerrequired
limitintegerrequired
nextCursorstring

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesnot_foundunauthorizednot_permittedinsufficient_scopeinvalid_requestadministration_unavailableinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/webhooks/{id}/deliveries" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/admin/webhooks/{id}/testSend a test event to a webhook; the result appears in its delivery logadmin

Audience: Integrations · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: test_webhook

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

202Successapplication/json

Example

{
  "attempts": 0,
  "createdAt": "2026-10-18T19:30:00Z",
  "durationMs": 1800000,
  "error": "string",
  "event": "string",
  "finishedAt": "2026-10-18T19:30:00Z",
  "id": "id_8h2k4q",
  "nextAttemptAt": "2026-10-18T19:30:00Z",
  "state": "string",
  "status": 0
}

Schema

attemptsintegerrequired
createdAtstringrequired
durationMsintegerrequired
errorstring
eventstringrequired
finishedAtstring
idstringrequired
nextAttemptAtstring
statestringrequired
statusintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codeswebhook_limitnot_foundunauthorizednot_permittedinsufficient_scopeinvalid_requestadministration_unavailableinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/webhooks/{id}/test" \
  -H "Authorization: Bearer $PORTICO_API_KEY"