2.3. Webhooks

class backendapp.webhooks.schemas.ConsumerWebhookSchema(*args, **kwargs)

A schema identical to ConsumerWebhookSchemaWithKey but with the webhook secret key omitted.

This is used for API endpoints that GET information about existing webhooks.

class Meta

class backendapp.webhooks.schemas.ConsumerWebhookSchemaWithKey(*args, **kwargs)

Schema for serialising a Webhook, which excludes the ID of the parent tag, but includes the serial string (as used in consumer API endpoints).

The webhook secret key is part of this schema. It must only be used for POSTing a new webhook.

class Meta

class backendapp.webhooks.schemas.WebhookSchema(*args, **kwargs)

Schema for serialising a Webhook read from the database.

This is intended for administrators only.

class Meta

model

alias of backendapp.webhooks.models.Webhook

admin_tag_url(obj)

Produce an absolute URL for the parent tag in the Admin API.

admin_webhook_url(obj)

Produce an absolute URL for this webhook in the Admin API.