Appearance
WebhookSubscription
Webhook subscriptions tell Artesa where to send events. Each one receives the events it lists, signed with its own secret.
OpenAPI Spec
List WebhookSubscriptions
GET
/v2/webhook-subscriptions
List WebhookSubscriptions
Authorizations
apiKey
Type
HTTP (bearer)
Parameters
Query Parameters
page
Type
number
Minimum
0Default
0size
Type
number
Minimum
1Maximum
20Default
10uuid
createdAt
updatedAt
Responses
List response
application/json
JSON "page": 0, "pages": 0, "size": 10, "items": [ { "uuid": "string", "url": "string", "events": [ "string" ], "secret": "string", "description": "string", "deactivatedAt": "string", "createdAt": "string", "updatedAt": "string" } ]
{
}
Create a new WebhookSubscription
POST
/v2/webhook-subscriptions
Create a new WebhookSubscription
Authorizations
apiKey
Type
HTTP (bearer)
Request Body
application/json
JSON "uuid": "string", "url": "string", "events": [ "string" ], "description": "string", "deactivatedAt": "string"
{
}
Responses
WebhookSubscription found
application/json
JSON "uuid": "string", "url": "string", "events": [ "string" ], "secret": "string", "description": "string", "deactivatedAt": "string", "createdAt": "string", "updatedAt": "string"
{
}
Get a WebhookSubscription
GET
/v2/webhook-subscriptions/{webhookSubscriptionUuid}
Get a WebhookSubscription by ID
Authorizations
apiKey
Type
HTTP (bearer)
Parameters
Path Parameters
webhookSubscriptionUuid*
Type
Requiredstring
Format
"uuid"Responses
WebhookSubscription found
application/json
JSON "uuid": "string", "url": "string", "events": [ "string" ], "secret": "string", "description": "string", "deactivatedAt": "string", "createdAt": "string", "updatedAt": "string"
{
}
Delete a WebhookSubscription
Update a WebhookSubscription
PATCH
/v2/webhook-subscriptions/{webhookSubscriptionUuid}
Update a WebhookSubscription by ID
Authorizations
apiKey
Type
HTTP (bearer)
Parameters
Path Parameters
webhookSubscriptionUuid*
Type
Requiredstring
Format
"uuid"Request Body
application/json
JSON "url": "string", "events": [ "string" ], "description": "string", "deactivatedAt": "string"
{
}
Responses
WebhookSubscription found
application/json
JSON "uuid": "string", "url": "string", "events": [ "string" ], "secret": "string", "description": "string", "deactivatedAt": "string", "createdAt": "string", "updatedAt": "string"
{
}