Webhooks

Get document webhooks

GET

https://api.digitoo.ai

/api/v2/documents/{document_id}/webhooks

Get document webhooks › path Parameters

document_id

string · uuid · required

An uuid identifier

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

Get document webhooks › Responses

WebhooksApiResponseDto

WebhookResponseDto[] · 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_id

required

A unique UUID or humanized id identifier

Get webhook signing key for organization › Responses

NullableWebhookSigningKeyResponseDto

NullableWebhookSigningKeyDto · 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_id

required

A unique UUID or humanized id identifier

Create webhook signing key for organization › Responses

WebhookSigningKeyResponseDto

WebhookSigningKeyDto · required

Get organization webhooks

GET

https://api.digitoo.ai

/api/v2/organizations/{organization_id}/webhooks

Get organization webhooks › path Parameters

organization_id

required

A unique UUID or humanized id identifier

Get organization webhooks › Responses

WebhooksApiResponseDto

WebhookResponseDto[] · required

Get queue webhooks

GET

https://api.digitoo.ai

/api/v2/queues/{queue_id}/webhooks

Get queue webhooks › path Parameters

queue_id

required

A unique UUID or humanized id identifier

Get queue webhooks › Responses

WebhooksApiResponseDto

WebhookResponseDto[] · required

Create webhook for entity

POST

https://api.digitoo.ai

/api/v2/webhooks

Create webhook for entity › Request Body

CreateWebhookDto

url

string · url · required

URL must be a valid HTTP URL

entity_type

string · enum · required

Enum values:

organization

workspace

queue

document

entity_id

string · uuid · required

type

string · enum

Enum values:

document_status_changed

queue_created

initial_document_validation

document_validation

Default: document_status_changed

signature_verification

string · enum

Enum values:

enabled

disabled

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_id

string · uuid · required

An uuid identifier

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

Get webhook by ID › Responses

WebhookApiResponseDto

WebhookResponseDto · required

Delete webhook for entity

DELETE

https://api.digitoo.ai

/api/v2/webhooks/{webhook_id}

Delete webhook for entity › path Parameters

webhook_id

string · 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_id

string · uuid · required

An uuid identifier

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

Patch webhook for entity › Request Body

UpdateWebhookDto

url

string · url · required

URL must be a valid HTTP URL

signature_verification

string · enum

Enum values:

enabled

disabled

destination_id

string | null · uuid

Patch webhook for entity › Responses

WebhookApiResponseDto

WebhookResponseDto · required

PATCH/api/v2/webhooks/{webhook_id}

curl https://api.digitoo.ai/api/v2/webhooks/:webhook_id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "url": "https://example.com",
  "signature_verification": "enabled",
  "destination_id": "550e8400-e29b-41d4-a716-446655440000"
}'

Example Request Body

{
  "url": "https://example.com",
  "signature_verification": "enabled",
  "destination_id": "550e8400-e29b-41d4-a716-446655440000"
}

json

application/json

Example Responses

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "entity_id": "550e8400-e29b-41d4-a716-446655440000",
    "entity_type": "organization",
    "url": "https://example.com",
    "signature_verification": "enabled",
    "type": "document_status_changed"
  }
}

json

application/json

Get workspace webhooks

GET

https://api.digitoo.ai

/api/v2/workspaces/{workspace_id}/webhooks

Get workspace webhooks › path Parameters

workspace_id

required

A unique UUID or humanized id identifier

Get workspace webhooks › Responses

WebhooksApiResponseDto

WebhookResponseDto[] · required

Documents User

Get document webhooks

GET

https://api.digitoo.ai

/api/v2/documents/{document_id}/webhooks

Get document webhooks › path Parameters

document_id

string · uuid · required

An uuid identifier

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

Get document webhooks › Responses

WebhooksApiResponseDto

WebhookResponseDto[] · 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_id

required

A unique UUID or humanized id identifier

Get webhook signing key for organization › Responses

NullableWebhookSigningKeyResponseDto

NullableWebhookSigningKeyDto · 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_id

required

A unique UUID or humanized id identifier

Create webhook signing key for organization › Responses

WebhookSigningKeyResponseDto

WebhookSigningKeyDto · required

Create webhook for entity

POST

https://api.digitoo.ai

/api/v2/webhooks

Create webhook for entity › Request Body

CreateWebhookDto

url

string · url · required

URL must be a valid HTTP URL

entity_type

string · enum · required

Enum values:

organization

workspace

queue

document

entity_id

string · uuid · required

type

string · enum

Enum values:

document_status_changed

queue_created

initial_document_validation

document_validation

Default: document_status_changed

signature_verification

string · enum

Enum values:

enabled

disabled

Create 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_id

string · uuid · required

An uuid identifier

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

Patch webhook for entity › Request Body

UpdateWebhookDto

url

string · url · required

URL must be a valid HTTP URL

signature_verification

string · enum

Enum values:

enabled

disabled

destination_id

string | null · uuid

Patch webhook for entity › Responses

WebhookApiResponseDto

WebhookResponseDto · required