Skip to main content
POST
Create a webhook subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId
string
required

Organization ID

Example:

"org-abc123"

Body

application/json
url
string
required

Destination URL that receives the signed webhook POST. Must be an https:// URL in production (http:// is only accepted when the server explicitly allows it for development). The host must not resolve to a private, loopback, link-local, or cloud-metadata address (SSRF guard).

Maximum string length: 2048
Example:

"https://example.com/hooks/nevermined"

eventTypes
enum<string>[]

Event types this subscription should receive. Omit or pass an empty array to subscribe to all event types.

Event types this subscription should receive. Omit or pass an empty array to subscribe to all event types.

Available options:
member.invited,
member.joined,
member.role_changed,
member.deactivated,
member.reactivated,
member.removed,
invitation.revoked,
invitation.expired,
group.created,
group.updated,
group.deactivated,
group.member_added,
group.member_removed,
group.budget_set,
group.budget_threshold_reached,
group.budget_exceeded,
group.budget_reset,
agent.created,
plan.created,
plan.updated,
plan.purchased,
customer.added,
customer.blocked,
customer.unblocked,
subscription.upgraded,
subscription.downgraded,
subscription.canceled,
subscription.lapsed,
webhook.delivered,
webhook.failed,
apikey.created,
apikey.revoked,
credits.redeemed
Example:
description
string

Optional human-readable label shown in the dashboard.

Example:

"Billing notifications"

Response

Webhook subscription created. The response wraps the subscription and the plaintext signing secret, which is returned only this once.