REST API

Webhooks

Webhooks enable an organization to receive on-complete project summaries without the need to log into the Privacy Dynamics Dashboard.

The webhook model

Webhooks have been modeled as a single sub-resource of Organization. All webhooks need to be supplied as a single specification and updated as a single atomic unit. This includes sending an empty specification to delete them.

Properties

  • Name
    on_project_complete
    Type
    string
    Description

    Endpoint URL where the webhook service will send requests when on-complete events occur.


GET/v1/organization/webhooks

Create or Update a webhook

Get webhook specification (i.e. all webhook call URIs) for a given organization

Request

Response


PUT/v1/organization/webhooks

Create or Update a webhook

Create or Update webhooks for a given organization

Request

Response


DELETE/v1/organization/webhooks

Delete a webhook

Delete webhook specification (i.e. all webhook call URIs) for a given organization

Request

Response

Next
What is Privacy Dynamics?