Digitoo.ai
Digitoo API rev. 2.0.0

Webhooks

Endpoint:https://api.digitoo.ai

Get document webhooks

GET
https://api.digitoo.ai
/api/v2/documents/{document_id}/webhooks

Get document webhooks › path Parameters

  • document_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

Get document webhooks › Responses

  • dataobject[] · required

Get webhook signing key for organization

GET
https://api.digitoo.ai
/api/v2/organizations/{organization_id}/webhook-signing-key

Get webhook signing key for organization › path Parameters

  • organization_idrequired

    A unique UUID or humanized id identifier

Get webhook signing key for organization › Responses

  • dataobject · required

Create webhook signing key for organization

POST
https://api.digitoo.ai
/api/v2/organizations/{organization_id}/webhook-signing-key

Create webhook signing key for organization › path Parameters

  • organization_idrequired

    A unique UUID or humanized id identifier

Create webhook signing key for organization › Responses

  • dataobject · required

Get organization webhooks

GET
https://api.digitoo.ai
/api/v2/organizations/{organization_id}/webhooks

Get organization webhooks › path Parameters

  • organization_idrequired

    A unique UUID or humanized id identifier

Get organization webhooks › Responses

  • dataobject[] · required

Get queue webhooks

GET
https://api.digitoo.ai
/api/v2/queues/{queue_id}/webhooks

Get queue webhooks › path Parameters

  • queue_idrequired

    A unique UUID or humanized id identifier

Get queue webhooks › Responses

  • dataobject[] · required

Create webhook for entity

POST
https://api.digitoo.ai
/api/v2/webhooks

Create webhook for entity › Request Body

  • urlstring · url · required

    URL must be a valid HTTP URL

  • entity_typerequired
  • entity_idstring · uuid · required
  • type | null
    Default: document_status_changed
  • signature_verification | null

Create webhook for entity › Responses

No data returned

Get webhook by ID

GET
https://api.digitoo.ai
/api/v2/webhooks/{webhook_id}

Get webhook by ID › path Parameters

  • webhook_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

Get webhook by ID › Responses

  • dataobject · required

Delete webhook for entity

DELETE
https://api.digitoo.ai
/api/v2/webhooks/{webhook_id}

Delete webhook for entity › path Parameters

  • webhook_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

Delete webhook for entity › Responses

No data returned

Patch webhook for entity

PATCH
https://api.digitoo.ai
/api/v2/webhooks/{webhook_id}

Patch webhook for entity › path Parameters

  • webhook_idstring · uuid · required

    An uuid identifier

    Example: 2555dc04-dc49-4d76-b14a-e4fd7b8a8b07

Patch webhook for entity › Request Body

  • urlstring · url · required

    URL must be a valid HTTP URL

  • signature_verification | null
  • destination_idstring | null · uuid

Patch webhook for entity › Responses

  • dataobject · required

Get workspace webhooks

GET
https://api.digitoo.ai
/api/v2/workspaces/{workspace_id}/webhooks

Get workspace webhooks › path Parameters

  • workspace_idrequired

    A unique UUID or humanized id identifier

Get workspace webhooks › Responses

  • dataobject[] · required
DocumentsUser