Skip to main content
PATCH
Update 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"

id
string
required

Webhook subscription ID

Example:

"whs-9c2f1a7e"

Body

application/json
url
string

New destination URL. Subject to the same https:// and SSRF validation as on create.

Maximum string length: 2048
Example:

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

eventTypes
enum<string>[]

Replacement list of event types. An empty array subscribes 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:
enabled
boolean

Enable or disable delivery. When false, the dispatcher skips this subscription.

Example:

true

description
string

Updated human-readable label shown in the dashboard.

Example:

"Billing notifications (prod)"

Response

Updated webhook subscription with the signing secret omitted