Skip to main content

Blueink OpenAPI Specfication

API docs by Redocly

BlueInk API v2 (2.2.4)

Download OpenAPI specification:Download

Overview

This document contains the detailed specification for version 2 of the BlueInk eSignature API. If just starting with the BlueInk API, you might want to checkout the Walkthroughs and Guides that supplement this API specification.

Bundles

List Bundles

Returns a paginated list of Bundles in your Account, ordered by created date (from most recent to least recent). Pagination can be controlled via Pagination paramaters (see Overview->Pagination). Querystring filters paramaters can be combined, e.g. /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. When combining filters, only Bundles matching ALL the filters are returned.

query Parameters
search
string

A search query. Only bundles matching the search will be returned. The following data in the the Bundle is searched:

  • bundle slug
  • bundle label
  • bundle custom_key
  • signer name
  • signer email
  • signer phones

E.g. /bundles/[email protected]

status
string
Enum: "dr" "se" "st" "co" "ca" "ex" "fa"

Limit bundles to those with the specified status.

  • dr: Draft - the Bundle has not yet been sent
  • se: Sent - the Bundle has been sent, but not yet started by any Signers
  • st: Started - at least one Signer has started reviewing the document(s)
  • co: Complete - all Signers have completed reviewing / signing
  • ca: Cancelled - the Bundle was cancelled
  • ex: Expired - the Bundle expired before it was Complete
  • fa: Failed - an error occurred and the Bundle could not be created or completed

E.g. /bundles/?status=co

status__in
string
Enum: "dr" "se" "st" "co" "ca" "ex" "fa"

Limit bundles to those with one of the specified statuses. Statuses should be comma separated. E.g. /bundles/?status=co,se,st

tag
string

Return Bundles that have the given tag. E.g. /bundles/?tag=some-tag

tag__in
string

Return Bundles that have at least one of the given tags. Tags should be comma separated. E.g. /bundles/?tag=some-tag,another-tag

ordering
string
Enum: "created" "sent" "completed_at"

Control the sort order of Bundles. Prefix with "-" to reverse the sort order. By default Bundles are sorted by "-created", ie the Bundle creation date from most to least recent.

created
string <date-time>

Retrieve Bundles created within a specified date range Note: Dates are expressed as YYYY-MM-DD format.

E.g. /bundles/?created_after=2024-10-01&created_before=2024-10-08

sent
string <date-time>

E.g. /bundles/?sent_after=2024-10-01&sent_before=2024-10-08

completed
string <date-time>

E.g. /bundles/?completed_after=2024-10-01&completed_before=2024-10-08

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Bundle

Request Body schema:
label
string

A label to help you identify this Bundle

in_order
boolean
Default: false

If true, Signers are required to sign in order, and a signing message (email or SMS) is sent to a Signer when previous signers have signed.

email_subject
string

A custom email subject that will be included in the email sent to each Signer.

email_message
string

A custom message that will be included in the email sent to each Signers via email. A message set on the individual PacketRequest takes precedence.

sms_message
string

A custom message that will be included in the SMS sent to each Signers. A message set on the individual PacketRequest takes precedence.

requester_name
string

The name of the requester. Defaults to the value configured for the Account (or Team).

requester_email
string <email>

The email address of the requester. Defaults to the value configured for the Account (or Team).

cc_emails
Array of strings <email> [ items <email > ]

An array of email addresses that should be cc'd when the documents are complete

custom_key
string <= 200 characters

An optional, unique custom key you can use to identify and retrieve this Bundle (e.g via search)

team
string <uuid>

A team ID, if teams are activated for your Account and you want to assign this Bundle to a particular team.

is_test
boolean

Set to True if this a test bundle. Test Bundles do not count against any account usage limits and cannot be used to create legally binding eSignatures. This should always be set to true while you App or integration is under development.

status
string
Enum: "" "dr"

Leave blank to send a bundle normally. Set to "dr" to create a draft bundle that is not sent automatically

object (BundlePayment)

You need to set up payout settings (Stripe Connect). After the signer has made the payment, the amount will be transferred to you via the previously set up Stripe account.

required
Array of objects (PacketRequest)
required
Array of DocumentRequest (object) or TemplateRequest (object)

Responses

Request samples

Content type
{
  • "label": "string",
  • "in_order": false,
  • "email_subject": "string",
  • "email_message": "string",
  • "sms_message": "string",
  • "requester_name": "string",
  • "requester_email": "[email protected]",
  • "cc_emails": [],
  • "custom_key": "string",
  • "team": "95527efb-6695-4aae-916e-c9869b1fb2bd",
  • "is_test": true,
  • "status": "",
  • "payment": {
    },
  • "packets": [
    ],
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "label": "string",
  • "in_order": false,
  • "email_subject": "string",
  • "email_message": "string",
  • "sms_message": "string",
  • "requester_name": "string",
  • "requester_email": "[email protected]",
  • "cc_emails": [],
  • "custom_key": "string",
  • "team": "95527efb-6695-4aae-916e-c9869b1fb2bd",
  • "is_test": true,
  • "status": "dr",
  • "payment": {
    },
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "docs_ready": true,
  • "errors": [
    ],
  • "packets": [
    ],
  • "documents": [
    ],
  • "tags": [
    ],
  • "data": [
    ]
}

Retrieve a Bundle

path Parameters
bundleSlug
required
string

The slug that uniquely identifies the Bundle

Responses

Response samples

Content type
application/json
{
  • "label": "string",
  • "in_order": false,
  • "email_subject": "string",
  • "email_message": "string",
  • "sms_message": "string",
  • "requester_name": "string",
  • "requester_email": "[email protected]",
  • "cc_emails": [],
  • "custom_key": "string",
  • "team": "95527efb-6695-4aae-916e-c9869b1fb2bd",
  • "is_test": true,
  • "status": "dr",
  • "payment": {
    },
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "docs_ready": true,
  • "errors": [
    ],
  • "packets": [
    ],
  • "documents": [
    ],
  • "tags": [
    ],
  • "data": [
    ]
}

Cancel a Bundle

path Parameters
bundleSlug
required
string

The slug that uniquely identifies the Bundle

Responses

Response samples

Content type
application/json
{
  • "label": "string",
  • "in_order": false,
  • "email_subject": "string",
  • "email_message": "string",
  • "sms_message": "string",
  • "requester_name": "string",
  • "requester_email": "[email protected]",
  • "cc_emails": [],
  • "custom_key": "string",
  • "team": "95527efb-6695-4aae-916e-c9869b1fb2bd",
  • "is_test": true,
  • "status": "dr",
  • "payment": {
    },
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "docs_ready": true,
  • "errors": [
    ],
  • "packets": [
    ],
  • "documents": [
    ],
  • "tags": [
    ],
  • "data": [
    ]
}

List Bundle Events

Get a list of Events that are associated with the Bundle

path Parameters
bundleSlug
required
string

The slug that uniquely identifies the Bundle

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve Bundle Files

Get downloadable files for a completed Bundle

path Parameters
bundleSlug
required
string

The slug that uniquely identifies the Bundle

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Generate Interim Bundle Files

Trigger generation of interim files. The Bundle cannot have a terminal status (Complete, Expired, etc). The files are generated asynchronously. You can poll the /bundles/{bundleSlug}/files/ endpoint with a GET request to retrieve the generated files. Note that the ability to generate interim files is not active for all API-enabled accounts. Check with Blueink support with any questions.

path Parameters
bundleSlug
required
string

The slug that uniquely identifies the Bundle

Responses

Response samples

Content type
application/json
{
  • "code": "authentication_failed",
  • "message": "string",
  • "errors": [
    ]
}

Retrieve Bundle Data

Get data entered into fields for a completed Bundle

path Parameters
bundleSlug
required
string

The slug that uniquely identifies the Bundle

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Tags to a bundle

Add additional tags to a Bundle. No existing tags on the Bundle are removed. The result of this call is that Bundle.tags is the union of the set of previous tags with the set of new tags. Duplicate tags are ignored.

path Parameters
bundleSlug
required
string

The slug that uniquely identifies the Bundle

Request Body schema: application/json
tags
Array of strings (Tags)

An array of tags

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "label": "string",
  • "in_order": false,
  • "email_subject": "string",
  • "email_message": "string",
  • "sms_message": "string",
  • "requester_name": "string",
  • "requester_email": "[email protected]",
  • "cc_emails": [],
  • "custom_key": "string",
  • "team": "95527efb-6695-4aae-916e-c9869b1fb2bd",
  • "is_test": true,
  • "status": "dr",
  • "payment": {
    },
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "docs_ready": true,
  • "errors": [
    ],
  • "packets": [
    ],
  • "documents": [
    ],
  • "tags": [
    ],
  • "data": [
    ]
}

Remove Tags from a bundle

Remove tags from a Bundle. If a tag in the request does not exist on the Bundle, it is ignored.

path Parameters
bundleSlug
required
string

The slug that uniquely identifies the Bundle

Request Body schema: application/json
tags
Array of strings (Tags)

An array of tags

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "label": "string",
  • "in_order": false,
  • "email_subject": "string",
  • "email_message": "string",
  • "sms_message": "string",
  • "requester_name": "string",
  • "requester_email": "[email protected]",
  • "cc_emails": [],
  • "custom_key": "string",
  • "team": "95527efb-6695-4aae-916e-c9869b1fb2bd",
  • "is_test": true,
  • "status": "dr",
  • "payment": {
    },
  • "id": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "docs_ready": true,
  • "errors": [
    ],
  • "packets": [
    ],
  • "documents": [
    ],
  • "tags": [
    ],
  • "data": [
    ]
}

Packet

Update a Packet

Update a Packet (aka signer) with a new email, phone number, name or authentication options

The updated packet must still be deliverable. For instance, if you specify a deliver_via value of 'phone', but there was no phone number set in the original PacketRequest, then this request must include a phone as well, or an error will be returned.

You can change a Packet that was originally configured for embedded signing (that is, deliver_via was 'embed') to be delivered via email or SMS. However, no signing notifications or reminders will be automatically sent. You must call /packet/{packetId}/remind/ to send a signing notification email (or SMS).

If this Signer is associated with a Person, the person will be updated as well - the Person name will be changed (if provided) and any new email or phone number will be added.

path Parameters
packetId
required
string

The slug that uniquely identifies the Packet

Request Body schema: application/json
name
string

The name of the signer

email
string <email>

The email address of the signer

phone
string <phone>

The phone number of the signer. Required if SMS Pin authentication is used.

auth_sms
boolean

True if you would like to require SMS pin authentication before a signer can sign the documents in this Bundle

auth_selfie
boolean

True if you would like to require Selfie authentication before a signer can sign the documents in this Bundle

auth_id
boolean

True if you would like to require ID authentication before a signer can sign the documents in this Bundle

deliver_via
string
Enum: "email" "phone"

Note that "embed" is not an option

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "[email protected]",
  • "phone": "string",
  • "auth_sms": true,
  • "auth_selfie": true,
  • "auth_id": true,
  • "deliver_via": "email"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "email": "[email protected]",
  • "phone": "string",
  • "auth_sms": true,
  • "auth_selfie": true,
  • "auth_id": true,
  • "id": "string",
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "status": "ne",
  • "deliver_via": "email",
  • "completed_at": "string",
  • "last_accessed_at": "string",
  • "order": 0
}

Create an Embedded Signing URL

Create a URL which can be used for embedded signing

Example Websites

path Parameters
packetId
required
string

The slug that uniquely identifies the Packet

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "expires": "2019-08-24T14:15:22Z"
}

Send a Reminder

Send a Reminder email or SMS to a Signer. A reminder can only be sent once every hour. The reminder will be sent via the delivery method (email or SMS) and to the email address (or phone number) previously designated for this Packet.

path Parameters
packetId
required
string

The slug that uniquely identifies the Packet

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "email": "[email protected]",
  • "phone": "string",
  • "auth_sms": true,
  • "auth_selfie": true,
  • "auth_id": true,
  • "id": "string",
  • "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  • "status": "ne",
  • "deliver_via": "email",
  • "completed_at": "string",
  • "last_accessed_at": "string",
  • "order": 0
}

Retrieve Packet Certificate of Evidence

Get a link and checksum of the Certificate of Evidence for this Packet

path Parameters
packetId
required
string

The slug that uniquely identifies the Packet

Responses

Response samples

Content type
application/json
{
  • "file_url": "string",
  • "expires": "string",
  • "sha256": "string"
}

Templates

List Document Templates

Responses

Response samples

Content type
application/json
{
  • "is_shared": true,
  • "name": "string",
  • "file_url": "string",
  • "roles": [
    ],
  • "fields": [
    ]
}

Retrieve a Document Template

path Parameters
templateId
required
string <uuid>

The ID that uniquely identifies the Template

Responses

Response samples

Content type
application/json
{
  • "is_shared": true,
  • "name": "string",
  • "file_url": "string",
  • "roles": [
    ],
  • "fields": [
    ]
}

Person

List Persons

query Parameters
search
string

A search query.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Person

Request Body schema: application/json
name
string

The name of the person

metadata
object

Metadata to associate with this person. Metadata can be used in SmartFill to automatically populate documents. See SmartFill documentation for details.

Array of objects (ContactChannel)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "metadata": { },
  • "channels": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "metadata": { },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_user": true,
  • "channels": [
    ]
}

Retrieve a Person

path Parameters
personId
required
string <uuid>

The ID that uniquely identifies the Person

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "metadata": { },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_user": true,
  • "channels": [
    ]
}

Update a Person

Update the Person with new data. NOTE that any contact channels that are omitted from this request will be DELETED. If you don't want to replace all data on the Person, you probably want to use PATCH instead.

path Parameters
personId
required
string <uuid>

The ID that uniquely identifies the Person

Request Body schema: application/json
name
string

The name of the person

metadata
object

Metadata to associate with this person. Metadata can be used in SmartFill to automatically populate documents. See SmartFill documentation for details.

Array of objects (ContactChannel)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "metadata": { },
  • "channels": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "metadata": { },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_user": true,
  • "channels": [
    ]
}

Partially update a Person

Partially update the Person with new data.

To add a new email or phone to the Person, include a ContactChannel in the 'channels' array without an 'id'.

To update an existing ContactChannel associated with the Person, include an 'id'. That existing ContactChannel will be updated with the new email or phone. This will update any live Bundles associated with the Person that are sending to that email (or phone).

If a ContactChannel does not include an 'id', but the email (or phone) matches an existing ContactChannel, then that ContactChannel will not be changed.

path Parameters
personId
required
string <uuid>

The ID that uniquely identifies the Person

Request Body schema: application/json
name
string

The name of the person

metadata
object

Metadata to associate with this person. Metadata can be used in SmartFill to automatically populate documents. See SmartFill documentation for details.

Array of objects (ContactChannel)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "metadata": { },
  • "channels": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "metadata": { },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_user": true,
  • "channels": [
    ]
}

Delete a Person

path Parameters
personId
required
string <uuid>

The ID that uniquely identifies the Person

Responses

Response samples

Content type
application/json
{
  • "code": "authentication_failed",
  • "message": "string",
  • "errors": [
    ]
}

Webhook

List Webhooks

query Parameters
enabled
boolean

Only Webhooks matching the selected 'enabled' state will be returned.

E.g. /webhooks/?enabled=true

event_type
string
Enum: "bundle_sent" "bundle_complete" "bundle_docs_ready" "bundle_error" "bundle_cancelled" "packet_viewed" "packet_complete"

Only Webhooks matching the selected event_type or event_types will be returned.

E.g. /webhooks/?event_type=bundle_sent E.g. /webhooks/?event_type__in=bundle_error,bundle_cancelled

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Webhook

Request Body schema: application/json
id
string <uuid>
url
string <url>

should be the full URL, including http/https

enabled
boolean
Default: true
json
boolean
Default: true
event_types
Array of strings
Items Enum: "bundle_sent" "bundle_complete" "bundle_docs_ready" "bundle_error" "bundle_cancelled" "packet_viewed" "packet_complete"

types of events that will fire the webhook

Array of objects (WebhookExtraHeader)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "url": "string",
  • "enabled": true,
  • "json": true,
  • "event_types": [
    ],
  • "extra_headers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "url": "string",
  • "enabled": true,
  • "json": true,
  • "event_types": [
    ],
  • "extra_headers": [
    ]
}

Retrieve a Webhook

path Parameters
webhookId
required
string <uuid>

The ID that uniquely identifies the Webhook

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "url": "string",
  • "enabled": true,
  • "json": true,
  • "event_types": [
    ],
  • "extra_headers": [
    ]
}

Update a Webhook

Update the Webhook with new data. NOTE that any subscriptions that are omitted from this request will be DELETED. If you don't want to replace all data on the Webhook, you probably want to use PATCH instead.

path Parameters
webhookId
required
string <uuid>

The ID that uniquely identifies the Webhook

Request Body schema: application/json
id
string <uuid>
url
string <url>

should be the full URL, including http/https

enabled
boolean
Default: true
json
boolean
Default: true
event_types
Array of strings
Items Enum: "bundle_sent" "bundle_complete" "bundle_docs_ready" "bundle_error" "bundle_cancelled" "packet_viewed" "packet_complete"

types of events that will fire the webhook

Array of objects (WebhookExtraHeader)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "url": "string",
  • "enabled": true,
  • "json": true,
  • "event_types": [
    ],
  • "extra_headers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "url": "string",
  • "enabled": true,
  • "json": true,
  • "event_types": [
    ],
  • "extra_headers": [
    ]
}

Partially update a Webhook

Partially update the Webhook with new data.

path Parameters
webhookId
required
string <uuid>

The ID that uniquely identifies the Webhook

Request Body schema: application/json
id
string <uuid>
url
string <url>

should be the full URL, including http/https

enabled
boolean
Default: true
json
boolean
Default: true
event_types
Array of strings
Items Enum: "bundle_sent" "bundle_complete" "bundle_docs_ready" "bundle_error" "bundle_cancelled" "packet_viewed" "packet_complete"

types of events that will fire the webhook

Array of objects (WebhookExtraHeader)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "url": "string",
  • "enabled": true,
  • "json": true,
  • "event_types": [
    ],
  • "extra_headers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "url": "string",
  • "enabled": true,
  • "json": true,
  • "event_types": [
    ],
  • "extra_headers": [
    ]
}

Delete a Webhook

path Parameters
webhookId
required
string <uuid>

The ID that uniquely identifies the Webhook

Responses

Response samples

Content type
application/json
{
  • "code": "authentication_failed",
  • "message": "string",
  • "errors": [
    ]
}

Retrieve a WebhookExtraHeader

path Parameters
webhookExtraHeaderId
required
string <uuid>

The ID that uniquely identifies the WebhookExtraHeader

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "webhook": "34cff408-bf77-4bc5-b31b-e3f4b806d7e8",
  • "name": "string",
  • "value": "string",
  • "order": 1
}

WebhookExtraHeader

List WebhookExtraHeaders

query Parameters
webhook
string <uuid>

Only WebhookExtraHeaders matching the selected webhook ID will be returned.

E.g. /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346

event_type
string
Enum: "bundle_sent" "bundle_complete" "bundle_docs_ready" "bundle_error" "bundle_cancelled" "packet_viewed" "packet_complete"

Only WebhookExtraHeaders with webhooks matching the selected event_type or event_types will be returned.

E.g. /webhooks/headers/?event_type=bundle_sent E.g. /webhooks/headers/?event_type__in=bundle_error,bundle_cancelled

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a WebhookExtraHeader

Request Body schema: application/json
id
string <uuid>
webhook
string <uuid>
name
string <= 80 characters

must adhere to RFC 7230

value
string <= 240 characters

must adhere to RFC 7230

order
integer
Default: 1

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "webhook": "34cff408-bf77-4bc5-b31b-e3f4b806d7e8",
  • "name": "string",
  • "value": "string",
  • "order": 1
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "webhook": "34cff408-bf77-4bc5-b31b-e3f4b806d7e8",
  • "name": "string",
  • "value": "string",
  • "order": 1
}

Update a WebhookExtraHeader

Update the WebhookExtraHeader with new data

path Parameters
webhookExtraHeaderId
required
string <uuid>

The ID that uniquely identifies the WebhookExtraHeader

Request Body schema: application/json
id
string <uuid>
webhook
string <uuid>
name
string <= 80 characters

must adhere to RFC 7230

value
string <= 240 characters

must adhere to RFC 7230

order
integer
Default: 1

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "webhook": "34cff408-bf77-4bc5-b31b-e3f4b806d7e8",
  • "name": "string",
  • "value": "string",
  • "order": 1
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "webhook": "34cff408-bf77-4bc5-b31b-e3f4b806d7e8",
  • "name": "string",
  • "value": "string",
  • "order": 1
}

Partially update a WebhookExtraHeader

Partially update the WebhookExtraHeader with new data.

path Parameters
webhookExtraHeaderId
required
string <uuid>

The ID that uniquely identifies the WebhookExtraHeader

Request Body schema: application/json
id
string <uuid>
webhook
string <uuid>
name
string <= 80 characters

must adhere to RFC 7230

value
string <= 240 characters

must adhere to RFC 7230

order
integer
Default: 1

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "webhook": "34cff408-bf77-4bc5-b31b-e3f4b806d7e8",
  • "name": "string",
  • "value": "string",
  • "order": 1
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "webhook": "34cff408-bf77-4bc5-b31b-e3f4b806d7e8",
  • "name": "string",
  • "value": "string",
  • "order": 1
}

Delete a WebhookExtraHeader

path Parameters
webhookExtraHeaderId
required
string <uuid>

The ID that uniquely identifies the WebhookExtraHeader

Responses

Response samples

Content type
application/json
{
  • "code": "authentication_failed",
  • "message": "string",
  • "errors": [
    ]
}

WebhookEvent

List WebhookEvents

query Parameters
webhook
string <uuid>

Only WebhookEvents matching the selected webhook ID will be returned.

E.g. /webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346

event_type
string
Enum: "bundle_sent" "bundle_complete" "bundle_docs_ready" "bundle_error" "bundle_cancelled" "packet_viewed" "packet_complete"

Only WebhookEvents with webhooks matching the selected event_type or event_types will be returned.

E.g. /webhooks/events/?event_type=bundle_sent E.g. /webhooks/events/?event_type__in=bundle_error,bundle_cancelled

status
integer

Only WebhookEvents matching the selected status will be returned.

E.g. /webhooks/events/?status=1 E.g. /webhooks/events/?status__in=0,1,2

success
boolean

Only WebhookEvents matching the selected success status will be returned.

E.g. /webhooks/events/?success=true

date
string <date-time>

Only WebhookEvents occurring between a date range will be returned. Note: Dates are expressed as YYYY-MM-DD format.

E.g. /webhooks/events/?date_after=2022-10-01&date_before=2022-10-31

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List WebhookEvents

query Parameters
webhook
string <uuid>

Only WebhookDeliveries matching the selected webhook ID will be returned.

E.g. /webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346

webhook_event
string <uuid>

Only WebhookDeliveries matching the selected webhook_event ID will be returned.

E.g. /webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346

event_type
string
Enum: "bundle_sent" "bundle_complete" "bundle_docs_ready" "bundle_error" "bundle_cancelled" "packet_viewed" "packet_complete"

Only WebhookDeliveries with webhooks matching the selected event_type or event_types will be returned.

E.g. /webhooks/deliveries/?event_type=bundle_sent E.g. /webhooks/deliveries/?event_type__in=bundle_error,bundle_cancelled

status
integer

Only WebhookDeliveries matching the selected status will be returned.

E.g. /webhooks/deliveries/?status=1 E.g. /webhooks/deliveries/?status__in=0,1,2

date
string <date-time>

Only WebhookDeliveries occurring between a date range will be returned. Note: Dates are expressed as YYYY-MM-DD format.

E.g. /webhooks/deliveries/?date_after=2022-10-01&date_before=2022-10-31

Responses

Response samples

Content type
application/json
[
  • {
    }
]

WebhookSecret

Get Webhook Shared Secret

Responses

Response samples

Content type
application/json
{
  • "secret": "string",
  • "create_date": "2019-08-24T14:15:22Z"
}

Regenerate Webhook Shared Secret

Responses

Response samples

Content type
application/json
{
  • "secret": "string",
  • "create_date": "2019-08-24T14:15:22Z"
}