Webhooks API

7 operations from the external ASIRI OpenAPI surface.

Public endpoint

GET`/v1/webhooks/subscriptions`

List webhook subscriptions for the active tenant

Requireswebhooks:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

No path or query parameters.

Request body

No request body.

Responses

GET/v1/webhooks/subscriptionsPublic schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/webhooks/subscriptions' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{}

Public endpoint

POST`/v1/webhooks/subscriptions`

Create a webhook subscription

Requireswebhooks:write

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

No path or query parameters.

Request body

application/jsonobject

Responses

POST/v1/webhooks/subscriptionsPublic schema

curl --request POST \
  --url 'https://api.asiri.ng/v1/webhooks/subscriptions' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://example.com",
  "events": [
    "string"
  ],
  "pinnedVersions": {
    "key": 1
  },
  "enabled": true,
  "secret": "string"
}'

Example response201

application/json

{}

Public endpoint

GET`/v1/webhooks/subscriptions/{id}`

Fetch a single webhook subscription

Requireswebhooks:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`id`	path	yes	`string`	-

Request body

No request body.

Responses

GET/v1/webhooks/subscriptions/{id}Public schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/webhooks/subscriptions/{id}' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{}

Public endpoint

PATCH`/v1/webhooks/subscriptions/{id}`

Update a webhook subscription

Requireswebhooks:write

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`id`	path	yes	`string`	-

Request body

application/jsonobject

Responses

PATC/v1/webhooks/subscriptions/{id}Public schema

curl --request PATCH \
  --url 'https://api.asiri.ng/v1/webhooks/subscriptions/{id}' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://example.com",
  "events": [
    "string"
  ],
  "pinnedVersions": {
    "key": 1
  },
  "enabled": true,
  "rotateSecret": true
}'

Example response200

application/json

{}

Public endpoint

DELETE`/v1/webhooks/subscriptions/{id}`

Delete a webhook subscription

Requireswebhooks:write

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`id`	path	yes	`string`	-

Request body

No request body.

Responses

DELE/v1/webhooks/subscriptions/{id}Public schema

curl --request DELETE \
  --url 'https://api.asiri.ng/v1/webhooks/subscriptions/{id}' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{}

Public endpoint

GET`/v1/webhooks/subscriptions/{id}/deliveries`

Fetch the delivery log for a subscription

Requiresaudit:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`id`	path	yes	`string`	-
`cursor`	query	no	`string`	-
`limit`	query	no	`integer`	-

Request body

No request body.

Responses

GET/v1/webhooks/subscriptions/{id}/deliveriesPublic schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/webhooks/subscriptions/{id}/deliveries' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{}

Public endpoint

POST`/v1/webhooks/subscriptions/{id}/test`

Enqueue a test event for a subscription

Requireswebhooks:write

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`id`	path	yes	`string`	-

Request body

No request body.

Responses

POST/v1/webhooks/subscriptions/{id}/testPublic schema

curl --request POST \
  --url 'https://api.asiri.ng/v1/webhooks/subscriptions/{id}/test' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{}

Webhooks API

GET/v1/webhooks/subscriptions

Security

Parameters

Request body

Responses

POST/v1/webhooks/subscriptions

Security

Parameters

Request body

Responses

GET/v1/webhooks/subscriptions/{id}

Security

Parameters

Request body

Responses

PATCH/v1/webhooks/subscriptions/{id}

Security

Parameters

Request body

Responses

DELETE/v1/webhooks/subscriptions/{id}

Security

Parameters

Request body

Responses

GET/v1/webhooks/subscriptions/{id}/deliveries

Security

Parameters

Request body

Responses

POST/v1/webhooks/subscriptions/{id}/test

Security

Parameters

Request body

Responses

GET`/v1/webhooks/subscriptions`

POST`/v1/webhooks/subscriptions`

GET`/v1/webhooks/subscriptions/{id}`

PATCH`/v1/webhooks/subscriptions/{id}`

DELETE`/v1/webhooks/subscriptions/{id}`

GET`/v1/webhooks/subscriptions/{id}/deliveries`

POST`/v1/webhooks/subscriptions/{id}/test`