GraphQL API Reference
Welcome to the Anvil GraphQL API reference! This reference includes the complete set of GraphQL types, queries, mutations, and their parameters for e-sign packets, workflows, PDF filling, and PDF generation. For more tutorial-oriented API documentation, please check out our API Guide.
Learn how to authenticate to the API in the Getting Started guide.
API Endpoints
Production:
https://graphql.useanvil.com
Terms of Service: https://www.useanvil.com/terms
Contact: support@useanvil.com
Queries
cast
Example
Query
query cast($eid: String!) {
cast(eid: $eid) {
id
eid
type
name
title
location
config(onlyKeys: $onlyKeys)
createdAt
updatedAt
organization {
...OrganizationFragment
}
versions {
...CastVersionFragment
}
archivedAt
fieldInfo
exampleData
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
query cast($eid: String!) {
cast(eid: $eid) {
id
eid
type
name
title
location
config(onlyKeys: $onlyKeys)
createdAt
updatedAt
organization {
...OrganizationFragment
}
versions {
...CastVersionFragment
}
archivedAt
fieldInfo
exampleData
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{
"data": {
"cast": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"type": "xyz789",
"name": "Cast Name",
"title": "Cast Title",
"location": "abc123",
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"organization": Organization,
"versions": [CastVersion],
"archivedAt": "2021-02-24T17:48:58.759Z",
"fieldInfo": {},
"exampleData": {}
}
}
}
currentUser
Example
Query
query currentUser {
currentUser {
id
eid
email
name
firstName
lastName
role
verifiedEmail
preferences {
...UserPreferencesFragment
}
organizations {
...OrganizationFragment
}
organizationUsers {
...OrganizationUserFragment
}
createdAt
updatedAt
}
}
query currentUser {
currentUser {
id
eid
email
name
firstName
lastName
role
verifiedEmail
preferences {
...UserPreferencesFragment
}
organizations {
...OrganizationFragment
}
organizationUsers {
...OrganizationUserFragment
}
createdAt
updatedAt
}
}
Response
{
"data": {
"currentUser": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"email": "user@domain.com",
"name": "User Name",
"firstName": "Bobby",
"lastName": "Jones",
"role": "user",
"verifiedEmail": true,
"preferences": UserPreferences,
"organizations": [Organization],
"organizationUsers": [OrganizationUser],
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
}
}
etchPacket
Example
Query
query etchPacket($eid: String!) {
etchPacket(eid: $eid) {
id
eid
name
organization {
...OrganizationFragment
}
documentGroup {
...DocumentGroupFragment
}
etchTemplate {
...EtchTemplateFragment
}
etchLogEvents {
...EtchLogFragment
}
userUploads {
...UserUploadFragment
}
isTest
payload
archivedAt
status
numberRemainingSigners
createdAt
updatedAt
detailsURL
webhookURL
webhookLogs {
...WebhookLogFragment
}
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
query etchPacket($eid: String!) {
etchPacket(eid: $eid) {
id
eid
name
organization {
...OrganizationFragment
}
documentGroup {
...DocumentGroupFragment
}
etchTemplate {
...EtchTemplateFragment
}
etchLogEvents {
...EtchLogFragment
}
userUploads {
...UserUploadFragment
}
isTest
payload
archivedAt
status
numberRemainingSigners
createdAt
updatedAt
detailsURL
webhookURL
webhookLogs {
...WebhookLogFragment
}
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{
"data": {
"etchPacket": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "EtchPacket Name",
"organization": Organization,
"documentGroup": DocumentGroup,
"etchTemplate": EtchTemplate,
"etchLogEvents": [EtchLog],
"userUploads": [UserUpload],
"isTest": false,
"payload": {},
"archivedAt": "2021-02-24T17:48:58.759Z",
"status": "xyz789",
"numberRemainingSigners": 123,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"detailsURL": "https://domain.com/page.html",
"webhookURL": "https://domain.com/page.html",
"webhookLogs": [WebhookLog]
}
}
}
forge
Example
Query
query forge($organizationSlug: String!, $eidOrSlug: String!) {
forge(organizationSlug: $organizationSlug, eidOrSlug: $eidOrSlug) {
id
eid
name
slug
config(onlyKeys: $onlyKeys)
fieldInfo
weld {
...WeldFragment
}
organization {
...OrganizationFragment
}
userUploads {
...UserUploadFragment
}
createdAt
updatedAt
versions {
...ForgeVersionFragment
}
archivedAt
isRequired
}
}
Variables
{
"organizationSlug": "organization-slug",
"eidOrSlug": "kQp2qd9FVUWrrE60hMbi"
}
query forge($organizationSlug: String!, $eidOrSlug: String!) {
forge(organizationSlug: $organizationSlug, eidOrSlug: $eidOrSlug) {
id
eid
name
slug
config(onlyKeys: $onlyKeys)
fieldInfo
weld {
...WeldFragment
}
organization {
...OrganizationFragment
}
userUploads {
...UserUploadFragment
}
createdAt
updatedAt
versions {
...ForgeVersionFragment
}
archivedAt
isRequired
}
}
{
"organizationSlug": "organization-slug",
"eidOrSlug": "kQp2qd9FVUWrrE60hMbi"
}
Response
{
"data": {
"forge": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Forge Name",
"slug": "forge-name",
"config": {},
"fieldInfo": {},
"weld": Weld,
"organization": Organization,
"userUploads": [UserUpload],
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"versions": [ForgeVersion],
"archivedAt": "2020-08-24T17:48:58.759Z",
"isRequired": false
}
}
}
organization
Example
Query
query organization($organizationSlug: String!) {
organization(organizationSlug: $organizationSlug) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
Variables
{
"organizationSlug": "organization-slug"
}
query organization($organizationSlug: String!) {
organization(organizationSlug: $organizationSlug) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
{
"organizationSlug": "organization-slug"
}
Response
{
"data": {
"organization": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Organization Name",
"logo": {},
"logoURL": "https://domain.com/page.html",
"parentOrganization": Organization,
"billingEmail": "user@domain.com",
"slug": "organization-name",
"users": [User],
"organizationUsers": [OrganizationUser],
"organizationUserInvites": [OrganizationUserInvite],
"isPersonal": false,
"isInternal": false,
"isSubscribed": "abc123",
"useTestSignatureProvider": true,
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"welds": [Weld],
"etchTemplates": [EtchTemplate],
"etchPackets": EtchPacketPage,
"weldGroups": [WeldGroup],
"forges": [Forge],
"forgeMaps": [ForgeMap],
"casts": [Cast],
"paymentMethods": [PaymentMethod],
"webhook": Webhook,
"webhookLogs": WebhookLogPage,
"childOrganizations": [Organization],
"subscribedPlanFeatures": {},
"subscriptionActivity": {},
"currentInvoice": Invoice,
"totalUsedUnits": 987,
"weldCompleteWebhookStats": {},
"weldCompleteStats": {},
"etchCompleteStats": {},
"remainingSubmissions": {},
"remainingEtchCompletions": {},
"signatureProviderType": "xyz789",
"availableSignatureProviderTypes": ["xyz789"]
}
}
}
signer
Example
Query
query signer($eid: String!, $token: String!) {
signer(eid: $eid, token: $token) {
id
eid
status
provider
providerConfig
aliasId
name
email
routingOrder
documentGroup {
...DocumentGroupFragment
}
createdAt
updatedAt
finishURL
etchSignURL
user {
...UserFragment
}
signActionType
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"token": "abc123"
}
query signer($eid: String!, $token: String!) {
signer(eid: $eid, token: $token) {
id
eid
status
provider
providerConfig
aliasId
name
email
routingOrder
documentGroup {
...DocumentGroupFragment
}
createdAt
updatedAt
finishURL
etchSignURL
user {
...UserFragment
}
signActionType
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"token": "abc123"
}
Response
{
"data": {
"signer": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"status": "xyz789",
"provider": "abc123",
"providerConfig": {},
"aliasId": "abc123",
"name": "Signer Name",
"email": "user@domain.com",
"routingOrder": 123,
"documentGroup": DocumentGroup,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"finishURL": "https://domain.com/page.html",
"etchSignURL": "https://domain.com/page.html",
"user": User,
"signActionType": "abc123"
}
}
}
submission
Submission
| Name | Description |
|---|---|
organizationSlug -
String!
|
|
forgeEidOrSlug -
String!
|
|
eid -
String!
|
|
forceCreate -
Boolean
|
|
timezone -
String
|
Example
Query
query submission($organizationSlug: String!, $forgeEidOrSlug: String!, $eid: String!, $forceCreate: Boolean, $timezone: String) {
submission(organizationSlug: $organizationSlug, forgeEidOrSlug: $forgeEidOrSlug, eid: $eid, forceCreate: $forceCreate, timezone: $timezone) {
id
eid
payload
payloadValue
requestMeta
currentStep
totalSteps
continueURL
user {
...UserFragment
}
forge {
...ForgeFragment
}
signer {
...SignerFragment
}
weldData {
...WeldDataFragment
}
completedAt
reviewData
completionPercentage
touchedByUser
isExcluded
status
createdAt
updatedAt
}
}
Variables
{
"organizationSlug": "organization-slug",
"forgeEidOrSlug": "kQp2qd9FVUWrrE60hMbi",
"eid": "kQp2qd9FVUWrrE60hMbi",
"forceCreate": false,
"timezone": "America/Los_Angeles"
}
query submission($organizationSlug: String!, $forgeEidOrSlug: String!, $eid: String!, $forceCreate: Boolean, $timezone: String) {
submission(organizationSlug: $organizationSlug, forgeEidOrSlug: $forgeEidOrSlug, eid: $eid, forceCreate: $forceCreate, timezone: $timezone) {
id
eid
payload
payloadValue
requestMeta
currentStep
totalSteps
continueURL
user {
...UserFragment
}
forge {
...ForgeFragment
}
signer {
...SignerFragment
}
weldData {
...WeldDataFragment
}
completedAt
reviewData
completionPercentage
touchedByUser
isExcluded
status
createdAt
updatedAt
}
}
{
"organizationSlug": "organization-slug",
"forgeEidOrSlug": "kQp2qd9FVUWrrE60hMbi",
"eid": "kQp2qd9FVUWrrE60hMbi",
"forceCreate": false,
"timezone": "America/Los_Angeles"
}
Response
{
"data": {
"submission": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"payload": {},
"payloadValue": {},
"requestMeta": {},
"currentStep": 987,
"totalSteps": 987,
"continueURL": "https://domain.com/page.html",
"user": User,
"forge": Forge,
"signer": Signer,
"weldData": WeldData,
"completedAt": "2021-02-24T17:48:58.759Z",
"reviewData": {},
"completionPercentage": 33.33,
"touchedByUser": true,
"isExcluded": true,
"status": "xyz789",
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
}
}
weld
Example
Query
query weld($organizationSlug: String!, $slug: String!) {
weld(organizationSlug: $organizationSlug, slug: $slug) {
id
eid
slug
name
title
visibility
config(onlyKeys: $onlyKeys)
organization {
...OrganizationFragment
}
createdAt
updatedAt
isTest
hasSigners
forges(isArchived: $isArchived) {
...ForgeFragment
}
casts {
...CastFragment
}
versions {
...WeldVersionFragment
}
weldGroups {
...WeldGroupFragment
}
weldDatas(touchedByUser: $touchedByUser, ignoreTest: $ignoreTest, isTest: $isTest, isArchived: $isArchived, statuses: $statuses, fromDate: $fromDate, toDate: $toDate, simpleSearchTerm: $simpleSearchTerm, limit: $limit, offset: $offset) {
...WeldDataPageFragment
}
hasWeldDatas
weldDataCounts
archivedAt
expiresAt
draftStep
signatureProviderType
availableSignatureProviderTypes
remainingSubmissions
}
}
Variables
{
"organizationSlug": "organization-slug",
"slug": "weld-name"
}
query weld($organizationSlug: String!, $slug: String!) {
weld(organizationSlug: $organizationSlug, slug: $slug) {
id
eid
slug
name
title
visibility
config(onlyKeys: $onlyKeys)
organization {
...OrganizationFragment
}
createdAt
updatedAt
isTest
hasSigners
forges(isArchived: $isArchived) {
...ForgeFragment
}
casts {
...CastFragment
}
versions {
...WeldVersionFragment
}
weldGroups {
...WeldGroupFragment
}
weldDatas(touchedByUser: $touchedByUser, ignoreTest: $ignoreTest, isTest: $isTest, isArchived: $isArchived, statuses: $statuses, fromDate: $fromDate, toDate: $toDate, simpleSearchTerm: $simpleSearchTerm, limit: $limit, offset: $offset) {
...WeldDataPageFragment
}
hasWeldDatas
weldDataCounts
archivedAt
expiresAt
draftStep
signatureProviderType
availableSignatureProviderTypes
remainingSubmissions
}
}
{
"organizationSlug": "organization-slug",
"slug": "weld-name"
}
Response
{
"data": {
"weld": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"slug": "weld-name",
"name": "Weld Name",
"title": "Weld Title",
"visibility": "abc123",
"config": {},
"organization": Organization,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"isTest": true,
"hasSigners": false,
"forges": [Forge],
"casts": [Cast],
"versions": [WeldVersion],
"weldGroups": [WeldGroup],
"weldDatas": WeldDataPage,
"hasWeldDatas": false,
"weldDataCounts": {},
"archivedAt": "2021-02-24T17:48:58.759Z",
"expiresAt": "2020-08-24T17:48:58.759Z",
"draftStep": "xyz789",
"signatureProviderType": "xyz789",
"availableSignatureProviderTypes": ["abc123"],
"remainingSubmissions": {}
}
}
}
weldData
Example
Query
query weldData($eid: String!) {
weldData(eid: $eid) {
id
eid
weld {
...WeldFragment
}
weldDataGroup {
...WeldDataGroupFragment
}
submissions {
...SubmissionFragment
}
isComplete
isExpired
isCompleteAndSigned
isTest
hasSigners
forgesRequiringCompletion {
...ForgeFragment
}
displayTitle
dataUpdatedAt
documentGroup {
...DocumentGroupFragment
}
continueURL
webhookURL
createdAt
updatedAt
expiresAt
status
payloadCanBeUpdated
completionPercentage
numberRemainingSigners
nextSigner {
...SignerFragment
}
archivedAt
files
excludedFiles
agents
pin
webhookLogs {
...WebhookLogFragment
}
etchLogEvents {
...EtchLogFragment
}
weldDataLogEvents {
...WeldDataLogFragment
}
userUploads {
...UserUploadFragment
}
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
query weldData($eid: String!) {
weldData(eid: $eid) {
id
eid
weld {
...WeldFragment
}
weldDataGroup {
...WeldDataGroupFragment
}
submissions {
...SubmissionFragment
}
isComplete
isExpired
isCompleteAndSigned
isTest
hasSigners
forgesRequiringCompletion {
...ForgeFragment
}
displayTitle
dataUpdatedAt
documentGroup {
...DocumentGroupFragment
}
continueURL
webhookURL
createdAt
updatedAt
expiresAt
status
payloadCanBeUpdated
completionPercentage
numberRemainingSigners
nextSigner {
...SignerFragment
}
archivedAt
files
excludedFiles
agents
pin
webhookLogs {
...WebhookLogFragment
}
etchLogEvents {
...EtchLogFragment
}
weldDataLogEvents {
...WeldDataLogFragment
}
userUploads {
...UserUploadFragment
}
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{
"data": {
"weldData": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"weld": Weld,
"weldDataGroup": WeldDataGroup,
"submissions": [Submission],
"isComplete": false,
"isExpired": false,
"isCompleteAndSigned": false,
"isTest": false,
"hasSigners": false,
"forgesRequiringCompletion": [Forge],
"displayTitle": "abc123",
"dataUpdatedAt": "2020-08-24T17:48:58.759Z",
"documentGroup": DocumentGroup,
"continueURL": "https://domain.com/page.html",
"webhookURL": "https://domain.com/page.html",
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"expiresAt": "2020-08-24T17:48:58.759Z",
"status": "xyz789",
"payloadCanBeUpdated": true,
"completionPercentage": "xyz789",
"numberRemainingSigners": 123,
"nextSigner": Signer,
"archivedAt": "2020-08-24T17:48:58.759Z",
"files": [{}],
"excludedFiles": [{}],
"agents": {},
"pin": "9876",
"webhookLogs": [WebhookLog],
"etchLogEvents": [EtchLog],
"weldDataLogEvents": [WeldDataLog],
"userUploads": [UserUpload]
}
}
}
Mutations
createCast
Example
Query
mutation createCast($organizationEid: String, $title: String, $file: Upload!) {
createCast(organizationEid: $organizationEid, title: $title, file: $file) {
id
eid
type
name
title
location
config(onlyKeys: $onlyKeys)
createdAt
updatedAt
organization {
...OrganizationFragment
}
versions {
...CastVersionFragment
}
archivedAt
fieldInfo
exampleData
}
}
Variables
{
"organizationEid": "kQp2qd9FVUWrrE60hMbi",
"title": "Cast Title",
"file": Upload
}
mutation createCast($organizationEid: String, $title: String, $file: Upload!) {
createCast(organizationEid: $organizationEid, title: $title, file: $file) {
id
eid
type
name
title
location
config(onlyKeys: $onlyKeys)
createdAt
updatedAt
organization {
...OrganizationFragment
}
versions {
...CastVersionFragment
}
archivedAt
fieldInfo
exampleData
}
}
{
"organizationEid": "kQp2qd9FVUWrrE60hMbi",
"title": "Cast Title",
"file": Upload
}
Response
{
"data": {
"createCast": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"type": "abc123",
"name": "Cast Name",
"title": "Cast Title",
"location": "xyz789",
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"organization": Organization,
"versions": [CastVersion],
"archivedAt": "2020-08-24T17:48:58.759Z",
"fieldInfo": {},
"exampleData": {}
}
}
}
createEtchPacket
EtchPacket
| Name | Description |
|---|---|
name -
String
|
|
organizationEid -
String
|
|
files -
[EtchFile!]
|
|
isDraft -
Boolean
|
|
isTest -
Boolean
|
|
signatureEmailSubject -
String
|
|
signatureEmailBody -
String
|
|
signatureProvider -
String
|
|
signaturePageOptions -
JSON
|
|
signers -
[JSON!]
|
|
data -
JSON
|
|
webhookURL -
String
|
Example
Query
mutation createEtchPacket($name: String, $organizationEid: String, $files: [EtchFile!], $isDraft: Boolean, $isTest: Boolean, $signatureEmailSubject: String, $signatureEmailBody: String, $signatureProvider: String, $signaturePageOptions: JSON, $signers: [JSON!], $data: JSON, $webhookURL: String) {
createEtchPacket(name: $name, organizationEid: $organizationEid, files: $files, isDraft: $isDraft, isTest: $isTest, signatureEmailSubject: $signatureEmailSubject, signatureEmailBody: $signatureEmailBody, signatureProvider: $signatureProvider, signaturePageOptions: $signaturePageOptions, signers: $signers, data: $data, webhookURL: $webhookURL) {
id
eid
name
organization {
...OrganizationFragment
}
documentGroup {
...DocumentGroupFragment
}
etchTemplate {
...EtchTemplateFragment
}
etchLogEvents {
...EtchLogFragment
}
userUploads {
...UserUploadFragment
}
isTest
payload
archivedAt
status
numberRemainingSigners
createdAt
updatedAt
detailsURL
webhookURL
webhookLogs {
...WebhookLogFragment
}
}
}
Variables
{
"name": "EtchPacket Name",
"organizationEid": "kQp2qd9FVUWrrE60hMbi",
"files": [EtchFile],
"isDraft": false,
"isTest": true,
"signatureEmailSubject": "abc123",
"signatureEmailBody": "xyz789",
"signatureProvider": "xyz789",
"signaturePageOptions": {},
"signers": [{}],
"data": {},
"webhookURL": "https://domain.com/page.html"
}
mutation createEtchPacket($name: String, $organizationEid: String, $files: [EtchFile!], $isDraft: Boolean, $isTest: Boolean, $signatureEmailSubject: String, $signatureEmailBody: String, $signatureProvider: String, $signaturePageOptions: JSON, $signers: [JSON!], $data: JSON, $webhookURL: String) {
createEtchPacket(name: $name, organizationEid: $organizationEid, files: $files, isDraft: $isDraft, isTest: $isTest, signatureEmailSubject: $signatureEmailSubject, signatureEmailBody: $signatureEmailBody, signatureProvider: $signatureProvider, signaturePageOptions: $signaturePageOptions, signers: $signers, data: $data, webhookURL: $webhookURL) {
id
eid
name
organization {
...OrganizationFragment
}
documentGroup {
...DocumentGroupFragment
}
etchTemplate {
...EtchTemplateFragment
}
etchLogEvents {
...EtchLogFragment
}
userUploads {
...UserUploadFragment
}
isTest
payload
archivedAt
status
numberRemainingSigners
createdAt
updatedAt
detailsURL
webhookURL
webhookLogs {
...WebhookLogFragment
}
}
}
{
"name": "EtchPacket Name",
"organizationEid": "kQp2qd9FVUWrrE60hMbi",
"files": [EtchFile],
"isDraft": false,
"isTest": true,
"signatureEmailSubject": "abc123",
"signatureEmailBody": "xyz789",
"signatureProvider": "xyz789",
"signaturePageOptions": {},
"signers": [{}],
"data": {},
"webhookURL": "https://domain.com/page.html"
}
Response
{
"data": {
"createEtchPacket": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "EtchPacket Name",
"organization": Organization,
"documentGroup": DocumentGroup,
"etchTemplate": EtchTemplate,
"etchLogEvents": [EtchLog],
"userUploads": [UserUpload],
"isTest": true,
"payload": {},
"archivedAt": "2020-08-24T17:48:58.759Z",
"status": "xyz789",
"numberRemainingSigners": 123,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"detailsURL": "https://domain.com/page.html",
"webhookURL": "https://domain.com/page.html",
"webhookLogs": [WebhookLog]
}
}
}
createForge
Forge
| Name | Description |
|---|---|
weldEid -
String!
|
|
name -
String!
|
|
slug -
String!
|
|
config -
JSON
|
|
castEid -
String
|
|
castFieldIds -
JSON
|
Example
Query
mutation createForge($weldEid: String!, $name: String!, $slug: String!, $config: JSON, $castEid: String, $castFieldIds: JSON) {
createForge(weldEid: $weldEid, name: $name, slug: $slug, config: $config, castEid: $castEid, castFieldIds: $castFieldIds) {
id
eid
name
slug
config(onlyKeys: $onlyKeys)
fieldInfo
weld {
...WeldFragment
}
organization {
...OrganizationFragment
}
userUploads {
...UserUploadFragment
}
createdAt
updatedAt
versions {
...ForgeVersionFragment
}
archivedAt
isRequired
}
}
Variables
{
"weldEid": "kQp2qd9FVUWrrE60hMbi",
"name": "Forge Name",
"slug": "forge-name",
"config": {},
"castEid": "kQp2qd9FVUWrrE60hMbi",
"castFieldIds": {}
}
mutation createForge($weldEid: String!, $name: String!, $slug: String!, $config: JSON, $castEid: String, $castFieldIds: JSON) {
createForge(weldEid: $weldEid, name: $name, slug: $slug, config: $config, castEid: $castEid, castFieldIds: $castFieldIds) {
id
eid
name
slug
config(onlyKeys: $onlyKeys)
fieldInfo
weld {
...WeldFragment
}
organization {
...OrganizationFragment
}
userUploads {
...UserUploadFragment
}
createdAt
updatedAt
versions {
...ForgeVersionFragment
}
archivedAt
isRequired
}
}
{
"weldEid": "kQp2qd9FVUWrrE60hMbi",
"name": "Forge Name",
"slug": "forge-name",
"config": {},
"castEid": "kQp2qd9FVUWrrE60hMbi",
"castFieldIds": {}
}
Response
{
"data": {
"createForge": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Forge Name",
"slug": "forge-name",
"config": {},
"fieldInfo": {},
"weld": Weld,
"organization": Organization,
"userUploads": [UserUpload],
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"versions": [ForgeVersion],
"archivedAt": "2020-08-24T17:48:58.759Z",
"isRequired": false
}
}
}
createSubmission
Example
Query
mutation createSubmission($forgeEid: String!, $weldDataEid: String!) {
createSubmission(forgeEid: $forgeEid, weldDataEid: $weldDataEid) {
id
eid
payload
payloadValue
requestMeta
currentStep
totalSteps
continueURL
user {
...UserFragment
}
forge {
...ForgeFragment
}
signer {
...SignerFragment
}
weldData {
...WeldDataFragment
}
completedAt
reviewData
completionPercentage
touchedByUser
isExcluded
status
createdAt
updatedAt
}
}
Variables
{
"forgeEid": "kQp2qd9FVUWrrE60hMbi",
"weldDataEid": "kQp2qd9FVUWrrE60hMbi"
}
mutation createSubmission($forgeEid: String!, $weldDataEid: String!) {
createSubmission(forgeEid: $forgeEid, weldDataEid: $weldDataEid) {
id
eid
payload
payloadValue
requestMeta
currentStep
totalSteps
continueURL
user {
...UserFragment
}
forge {
...ForgeFragment
}
signer {
...SignerFragment
}
weldData {
...WeldDataFragment
}
completedAt
reviewData
completionPercentage
touchedByUser
isExcluded
status
createdAt
updatedAt
}
}
{
"forgeEid": "kQp2qd9FVUWrrE60hMbi",
"weldDataEid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{
"data": {
"createSubmission": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"payload": {},
"payloadValue": {},
"requestMeta": {},
"currentStep": 987,
"totalSteps": 987,
"continueURL": "https://domain.com/page.html",
"user": User,
"forge": Forge,
"signer": Signer,
"weldData": WeldData,
"completedAt": "2020-08-24T17:48:58.759Z",
"reviewData": {},
"completionPercentage": 33.33,
"touchedByUser": false,
"isExcluded": true,
"status": "abc123",
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
}
}
createWebhook
Example
Query
mutation createWebhook($organizationSlug: String!, $url: String) {
createWebhook(organizationSlug: $organizationSlug, url: $url) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
Variables
{
"organizationSlug": "organization-slug",
"url": "https://domain.com/page.html"
}
mutation createWebhook($organizationSlug: String!, $url: String) {
createWebhook(organizationSlug: $organizationSlug, url: $url) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
{
"organizationSlug": "organization-slug",
"url": "https://domain.com/page.html"
}
Response
{
"data": {
"createWebhook": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Organization Name",
"logo": {},
"logoURL": "https://domain.com/page.html",
"parentOrganization": Organization,
"billingEmail": "user@domain.com",
"slug": "organization-name",
"users": [User],
"organizationUsers": [OrganizationUser],
"organizationUserInvites": [OrganizationUserInvite],
"isPersonal": true,
"isInternal": true,
"isSubscribed": "xyz789",
"useTestSignatureProvider": true,
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"welds": [Weld],
"etchTemplates": [EtchTemplate],
"etchPackets": EtchPacketPage,
"weldGroups": [WeldGroup],
"forges": [Forge],
"forgeMaps": [ForgeMap],
"casts": [Cast],
"paymentMethods": [PaymentMethod],
"webhook": Webhook,
"webhookLogs": WebhookLogPage,
"childOrganizations": [Organization],
"subscribedPlanFeatures": {},
"subscriptionActivity": {},
"currentInvoice": Invoice,
"totalUsedUnits": 123,
"weldCompleteWebhookStats": {},
"weldCompleteStats": {},
"etchCompleteStats": {},
"remainingSubmissions": {},
"remainingEtchCompletions": {},
"signatureProviderType": "xyz789",
"availableSignatureProviderTypes": ["abc123"]
}
}
}
createWeld
Weld
| Name | Description |
|---|---|
organizationEid -
String!
|
|
name -
String!
|
|
slug -
String
|
|
visibility -
String
|
|
draftStep -
String
|
|
config -
JSON
|
|
castEid -
String
|
Example
Query
mutation createWeld($organizationEid: String!, $name: String!, $slug: String, $visibility: String, $draftStep: String, $config: JSON, $castEid: String) {
createWeld(organizationEid: $organizationEid, name: $name, slug: $slug, visibility: $visibility, draftStep: $draftStep, config: $config, castEid: $castEid) {
id
eid
slug
name
title
visibility
config(onlyKeys: $onlyKeys)
organization {
...OrganizationFragment
}
createdAt
updatedAt
isTest
hasSigners
forges(isArchived: $isArchived) {
...ForgeFragment
}
casts {
...CastFragment
}
versions {
...WeldVersionFragment
}
weldGroups {
...WeldGroupFragment
}
weldDatas(touchedByUser: $touchedByUser, ignoreTest: $ignoreTest, isTest: $isTest, isArchived: $isArchived, statuses: $statuses, fromDate: $fromDate, toDate: $toDate, simpleSearchTerm: $simpleSearchTerm, limit: $limit, offset: $offset) {
...WeldDataPageFragment
}
hasWeldDatas
weldDataCounts
archivedAt
expiresAt
draftStep
signatureProviderType
availableSignatureProviderTypes
remainingSubmissions
}
}
Variables
{
"organizationEid": "kQp2qd9FVUWrrE60hMbi",
"name": "Weld Name",
"slug": "weld-name",
"visibility": "abc123",
"draftStep": "xyz789",
"config": {},
"castEid": "kQp2qd9FVUWrrE60hMbi"
}
mutation createWeld($organizationEid: String!, $name: String!, $slug: String, $visibility: String, $draftStep: String, $config: JSON, $castEid: String) {
createWeld(organizationEid: $organizationEid, name: $name, slug: $slug, visibility: $visibility, draftStep: $draftStep, config: $config, castEid: $castEid) {
id
eid
slug
name
title
visibility
config(onlyKeys: $onlyKeys)
organization {
...OrganizationFragment
}
createdAt
updatedAt
isTest
hasSigners
forges(isArchived: $isArchived) {
...ForgeFragment
}
casts {
...CastFragment
}
versions {
...WeldVersionFragment
}
weldGroups {
...WeldGroupFragment
}
weldDatas(touchedByUser: $touchedByUser, ignoreTest: $ignoreTest, isTest: $isTest, isArchived: $isArchived, statuses: $statuses, fromDate: $fromDate, toDate: $toDate, simpleSearchTerm: $simpleSearchTerm, limit: $limit, offset: $offset) {
...WeldDataPageFragment
}
hasWeldDatas
weldDataCounts
archivedAt
expiresAt
draftStep
signatureProviderType
availableSignatureProviderTypes
remainingSubmissions
}
}
{
"organizationEid": "kQp2qd9FVUWrrE60hMbi",
"name": "Weld Name",
"slug": "weld-name",
"visibility": "abc123",
"draftStep": "xyz789",
"config": {},
"castEid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{
"data": {
"createWeld": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"slug": "weld-name",
"name": "Weld Name",
"title": "Weld Title",
"visibility": "xyz789",
"config": {},
"organization": Organization,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"isTest": false,
"hasSigners": false,
"forges": [Forge],
"casts": [Cast],
"versions": [WeldVersion],
"weldGroups": [WeldGroup],
"weldDatas": WeldDataPage,
"hasWeldDatas": true,
"weldDataCounts": {},
"archivedAt": "2020-08-24T17:48:58.759Z",
"expiresAt": "2021-02-24T17:48:58.759Z",
"draftStep": "abc123",
"signatureProviderType": "abc123",
"availableSignatureProviderTypes": ["abc123"],
"remainingSubmissions": {}
}
}
}
createWeldData
WeldData
| Name | Description |
|---|---|
weldEid -
String!
|
|
weldDataGroupEid -
String
|
|
isTest -
Boolean
|
Default = false |
webhookURL -
String
|
Example
Query
mutation createWeldData($weldEid: String!, $weldDataGroupEid: String, $isTest: Boolean, $webhookURL: String) {
createWeldData(weldEid: $weldEid, weldDataGroupEid: $weldDataGroupEid, isTest: $isTest, webhookURL: $webhookURL) {
id
eid
weld {
...WeldFragment
}
weldDataGroup {
...WeldDataGroupFragment
}
submissions {
...SubmissionFragment
}
isComplete
isExpired
isCompleteAndSigned
isTest
hasSigners
forgesRequiringCompletion {
...ForgeFragment
}
displayTitle
dataUpdatedAt
documentGroup {
...DocumentGroupFragment
}
continueURL
webhookURL
createdAt
updatedAt
expiresAt
status
payloadCanBeUpdated
completionPercentage
numberRemainingSigners
nextSigner {
...SignerFragment
}
archivedAt
files
excludedFiles
agents
pin
webhookLogs {
...WebhookLogFragment
}
etchLogEvents {
...EtchLogFragment
}
weldDataLogEvents {
...WeldDataLogFragment
}
userUploads {
...UserUploadFragment
}
}
}
Variables
{
"weldEid": "kQp2qd9FVUWrrE60hMbi",
"weldDataGroupEid": "kQp2qd9FVUWrrE60hMbi",
"isTest": true,
"webhookURL": "https://domain.com/page.html"
}
mutation createWeldData($weldEid: String!, $weldDataGroupEid: String, $isTest: Boolean, $webhookURL: String) {
createWeldData(weldEid: $weldEid, weldDataGroupEid: $weldDataGroupEid, isTest: $isTest, webhookURL: $webhookURL) {
id
eid
weld {
...WeldFragment
}
weldDataGroup {
...WeldDataGroupFragment
}
submissions {
...SubmissionFragment
}
isComplete
isExpired
isCompleteAndSigned
isTest
hasSigners
forgesRequiringCompletion {
...ForgeFragment
}
displayTitle
dataUpdatedAt
documentGroup {
...DocumentGroupFragment
}
continueURL
webhookURL
createdAt
updatedAt
expiresAt
status
payloadCanBeUpdated
completionPercentage
numberRemainingSigners
nextSigner {
...SignerFragment
}
archivedAt
files
excludedFiles
agents
pin
webhookLogs {
...WebhookLogFragment
}
etchLogEvents {
...EtchLogFragment
}
weldDataLogEvents {
...WeldDataLogFragment
}
userUploads {
...UserUploadFragment
}
}
}
{
"weldEid": "kQp2qd9FVUWrrE60hMbi",
"weldDataGroupEid": "kQp2qd9FVUWrrE60hMbi",
"isTest": true,
"webhookURL": "https://domain.com/page.html"
}
Response
{
"data": {
"createWeldData": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"weld": Weld,
"weldDataGroup": WeldDataGroup,
"submissions": [Submission],
"isComplete": false,
"isExpired": false,
"isCompleteAndSigned": false,
"isTest": false,
"hasSigners": false,
"forgesRequiringCompletion": [Forge],
"displayTitle": "xyz789",
"dataUpdatedAt": "2021-02-24T17:48:58.759Z",
"documentGroup": DocumentGroup,
"continueURL": "https://domain.com/page.html",
"webhookURL": "https://domain.com/page.html",
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"expiresAt": "2020-08-24T17:48:58.759Z",
"status": "abc123",
"payloadCanBeUpdated": true,
"completionPercentage": "xyz789",
"numberRemainingSigners": 987,
"nextSigner": Signer,
"archivedAt": "2020-08-24T17:48:58.759Z",
"files": [{}],
"excludedFiles": [{}],
"agents": {},
"pin": "9876",
"webhookLogs": [WebhookLog],
"etchLogEvents": [EtchLog],
"weldDataLogEvents": [WeldDataLog],
"userUploads": [UserUpload]
}
}
}
destroySubmission
Example
Query
mutation destroySubmission($eid: String!) {
destroySubmission(eid: $eid)
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
mutation destroySubmission($eid: String!) {
destroySubmission(eid: $eid)
}
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{"data": {"destroySubmission": true}}
disconnectDocusign
Example
Query
mutation disconnectDocusign($organizationSlug: String!) {
disconnectDocusign(organizationSlug: $organizationSlug) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
Variables
{
"organizationSlug": "organization-slug"
}
mutation disconnectDocusign($organizationSlug: String!) {
disconnectDocusign(organizationSlug: $organizationSlug) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
{
"organizationSlug": "organization-slug"
}
Response
{
"data": {
"disconnectDocusign": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Organization Name",
"logo": {},
"logoURL": "https://domain.com/page.html",
"parentOrganization": Organization,
"billingEmail": "user@domain.com",
"slug": "organization-name",
"users": [User],
"organizationUsers": [OrganizationUser],
"organizationUserInvites": [OrganizationUserInvite],
"isPersonal": false,
"isInternal": false,
"isSubscribed": "xyz789",
"useTestSignatureProvider": true,
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"welds": [Weld],
"etchTemplates": [EtchTemplate],
"etchPackets": EtchPacketPage,
"weldGroups": [WeldGroup],
"forges": [Forge],
"forgeMaps": [ForgeMap],
"casts": [Cast],
"paymentMethods": [PaymentMethod],
"webhook": Webhook,
"webhookLogs": WebhookLogPage,
"childOrganizations": [Organization],
"subscribedPlanFeatures": {},
"subscriptionActivity": {},
"currentInvoice": Invoice,
"totalUsedUnits": 987,
"weldCompleteWebhookStats": {},
"weldCompleteStats": {},
"etchCompleteStats": {},
"remainingSubmissions": {},
"remainingEtchCompletions": {},
"signatureProviderType": "abc123",
"availableSignatureProviderTypes": ["abc123"]
}
}
}
duplicateCast
Example
Query
mutation duplicateCast($eid: String!, $organizationEid: String!) {
duplicateCast(eid: $eid, organizationEid: $organizationEid) {
id
eid
type
name
title
location
config(onlyKeys: $onlyKeys)
createdAt
updatedAt
organization {
...OrganizationFragment
}
versions {
...CastVersionFragment
}
archivedAt
fieldInfo
exampleData
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"organizationEid": "kQp2qd9FVUWrrE60hMbi"
}
mutation duplicateCast($eid: String!, $organizationEid: String!) {
duplicateCast(eid: $eid, organizationEid: $organizationEid) {
id
eid
type
name
title
location
config(onlyKeys: $onlyKeys)
createdAt
updatedAt
organization {
...OrganizationFragment
}
versions {
...CastVersionFragment
}
archivedAt
fieldInfo
exampleData
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"organizationEid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{
"data": {
"duplicateCast": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"type": "abc123",
"name": "Cast Name",
"title": "Cast Title",
"location": "xyz789",
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"organization": Organization,
"versions": [CastVersion],
"archivedAt": "2021-02-24T17:48:58.759Z",
"fieldInfo": {},
"exampleData": {}
}
}
}
duplicateWeld
Example
Query
mutation duplicateWeld($eid: String!, $organizationEid: String!, $visibility: String) {
duplicateWeld(eid: $eid, organizationEid: $organizationEid, visibility: $visibility) {
id
eid
slug
name
title
visibility
config(onlyKeys: $onlyKeys)
organization {
...OrganizationFragment
}
createdAt
updatedAt
isTest
hasSigners
forges(isArchived: $isArchived) {
...ForgeFragment
}
casts {
...CastFragment
}
versions {
...WeldVersionFragment
}
weldGroups {
...WeldGroupFragment
}
weldDatas(touchedByUser: $touchedByUser, ignoreTest: $ignoreTest, isTest: $isTest, isArchived: $isArchived, statuses: $statuses, fromDate: $fromDate, toDate: $toDate, simpleSearchTerm: $simpleSearchTerm, limit: $limit, offset: $offset) {
...WeldDataPageFragment
}
hasWeldDatas
weldDataCounts
archivedAt
expiresAt
draftStep
signatureProviderType
availableSignatureProviderTypes
remainingSubmissions
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"organizationEid": "kQp2qd9FVUWrrE60hMbi",
"visibility": "abc123"
}
mutation duplicateWeld($eid: String!, $organizationEid: String!, $visibility: String) {
duplicateWeld(eid: $eid, organizationEid: $organizationEid, visibility: $visibility) {
id
eid
slug
name
title
visibility
config(onlyKeys: $onlyKeys)
organization {
...OrganizationFragment
}
createdAt
updatedAt
isTest
hasSigners
forges(isArchived: $isArchived) {
...ForgeFragment
}
casts {
...CastFragment
}
versions {
...WeldVersionFragment
}
weldGroups {
...WeldGroupFragment
}
weldDatas(touchedByUser: $touchedByUser, ignoreTest: $ignoreTest, isTest: $isTest, isArchived: $isArchived, statuses: $statuses, fromDate: $fromDate, toDate: $toDate, simpleSearchTerm: $simpleSearchTerm, limit: $limit, offset: $offset) {
...WeldDataPageFragment
}
hasWeldDatas
weldDataCounts
archivedAt
expiresAt
draftStep
signatureProviderType
availableSignatureProviderTypes
remainingSubmissions
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"organizationEid": "kQp2qd9FVUWrrE60hMbi",
"visibility": "abc123"
}
Response
{
"data": {
"duplicateWeld": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"slug": "weld-name",
"name": "Weld Name",
"title": "Weld Title",
"visibility": "xyz789",
"config": {},
"organization": Organization,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"isTest": false,
"hasSigners": false,
"forges": [Forge],
"casts": [Cast],
"versions": [WeldVersion],
"weldGroups": [WeldGroup],
"weldDatas": WeldDataPage,
"hasWeldDatas": true,
"weldDataCounts": {},
"archivedAt": "2021-02-24T17:48:58.759Z",
"expiresAt": "2020-08-24T17:48:58.759Z",
"draftStep": "xyz789",
"signatureProviderType": "xyz789",
"availableSignatureProviderTypes": ["abc123"],
"remainingSubmissions": {}
}
}
}
forgeSubmit
Submission
| Name | Description |
|---|---|
forgeEid -
String!
|
|
weldDataEid -
String
|
|
submissionEid -
String
|
|
payload -
JSON!
|
|
currentStep -
Int
|
|
complete -
Boolean
|
|
isTest -
Boolean
|
Default = false |
timezone -
String
|
|
webhookURL -
String
|
|
groupArrayId -
String
|
|
groupArrayIndex -
Int
|
Example
Query
mutation forgeSubmit($forgeEid: String!, $weldDataEid: String, $submissionEid: String, $payload: JSON!, $currentStep: Int, $complete: Boolean, $isTest: Boolean, $timezone: String, $webhookURL: String, $groupArrayId: String, $groupArrayIndex: Int) {
forgeSubmit(forgeEid: $forgeEid, weldDataEid: $weldDataEid, submissionEid: $submissionEid, payload: $payload, currentStep: $currentStep, complete: $complete, isTest: $isTest, timezone: $timezone, webhookURL: $webhookURL, groupArrayId: $groupArrayId, groupArrayIndex: $groupArrayIndex) {
id
eid
payload
payloadValue
requestMeta
currentStep
totalSteps
continueURL
user {
...UserFragment
}
forge {
...ForgeFragment
}
signer {
...SignerFragment
}
weldData {
...WeldDataFragment
}
completedAt
reviewData
completionPercentage
touchedByUser
isExcluded
status
createdAt
updatedAt
}
}
Variables
{
"forgeEid": "kQp2qd9FVUWrrE60hMbi",
"weldDataEid": "kQp2qd9FVUWrrE60hMbi",
"submissionEid": "kQp2qd9FVUWrrE60hMbi",
"payload": {},
"currentStep": 987,
"complete": true,
"isTest": true,
"timezone": "America/Los_Angeles",
"webhookURL": "https://domain.com/page.html",
"groupArrayId": "abc123",
"groupArrayIndex": 123
}
mutation forgeSubmit($forgeEid: String!, $weldDataEid: String, $submissionEid: String, $payload: JSON!, $currentStep: Int, $complete: Boolean, $isTest: Boolean, $timezone: String, $webhookURL: String, $groupArrayId: String, $groupArrayIndex: Int) {
forgeSubmit(forgeEid: $forgeEid, weldDataEid: $weldDataEid, submissionEid: $submissionEid, payload: $payload, currentStep: $currentStep, complete: $complete, isTest: $isTest, timezone: $timezone, webhookURL: $webhookURL, groupArrayId: $groupArrayId, groupArrayIndex: $groupArrayIndex) {
id
eid
payload
payloadValue
requestMeta
currentStep
totalSteps
continueURL
user {
...UserFragment
}
forge {
...ForgeFragment
}
signer {
...SignerFragment
}
weldData {
...WeldDataFragment
}
completedAt
reviewData
completionPercentage
touchedByUser
isExcluded
status
createdAt
updatedAt
}
}
{
"forgeEid": "kQp2qd9FVUWrrE60hMbi",
"weldDataEid": "kQp2qd9FVUWrrE60hMbi",
"submissionEid": "kQp2qd9FVUWrrE60hMbi",
"payload": {},
"currentStep": 987,
"complete": true,
"isTest": true,
"timezone": "America/Los_Angeles",
"webhookURL": "https://domain.com/page.html",
"groupArrayId": "abc123",
"groupArrayIndex": 123
}
Response
{
"data": {
"forgeSubmit": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"payload": {},
"payloadValue": {},
"requestMeta": {},
"currentStep": 987,
"totalSteps": 123,
"continueURL": "https://domain.com/page.html",
"user": User,
"forge": Forge,
"signer": Signer,
"weldData": WeldData,
"completedAt": "2020-08-24T17:48:58.759Z",
"reviewData": {},
"completionPercentage": 33.33,
"touchedByUser": true,
"isExcluded": false,
"status": "abc123",
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
}
}
generateEtchSignURL
Example
Query
mutation generateEtchSignURL($signerEid: String!, $clientUserId: String!) {
generateEtchSignURL(signerEid: $signerEid, clientUserId: $clientUserId)
}
Variables
{
"signerEid": "kQp2qd9FVUWrrE60hMbi",
"clientUserId": "abc123"
}
mutation generateEtchSignURL($signerEid: String!, $clientUserId: String!) {
generateEtchSignURL(signerEid: $signerEid, clientUserId: $clientUserId)
}
{
"signerEid": "kQp2qd9FVUWrrE60hMbi",
"clientUserId": "abc123"
}
Response
{"data": {"generateEtchSignURL": "xyz789"}}
removeEtchPacket
Example
Query
mutation removeEtchPacket($eid: String!) {
removeEtchPacket(eid: $eid)
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
mutation removeEtchPacket($eid: String!) {
removeEtchPacket(eid: $eid)
}
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{"data": {"removeEtchPacket": false}}
removeWebhook
Example
Query
mutation removeWebhook($eid: String!) {
removeWebhook(eid: $eid) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
mutation removeWebhook($eid: String!) {
removeWebhook(eid: $eid) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{
"data": {
"removeWebhook": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Organization Name",
"logo": {},
"logoURL": "https://domain.com/page.html",
"parentOrganization": Organization,
"billingEmail": "user@domain.com",
"slug": "organization-name",
"users": [User],
"organizationUsers": [OrganizationUser],
"organizationUserInvites": [OrganizationUserInvite],
"isPersonal": false,
"isInternal": false,
"isSubscribed": "abc123",
"useTestSignatureProvider": true,
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"welds": [Weld],
"etchTemplates": [EtchTemplate],
"etchPackets": EtchPacketPage,
"weldGroups": [WeldGroup],
"forges": [Forge],
"forgeMaps": [ForgeMap],
"casts": [Cast],
"paymentMethods": [PaymentMethod],
"webhook": Webhook,
"webhookLogs": WebhookLogPage,
"childOrganizations": [Organization],
"subscribedPlanFeatures": {},
"subscriptionActivity": {},
"currentInvoice": Invoice,
"totalUsedUnits": 123,
"weldCompleteWebhookStats": {},
"weldCompleteStats": {},
"etchCompleteStats": {},
"remainingSubmissions": {},
"remainingEtchCompletions": {},
"signatureProviderType": "abc123",
"availableSignatureProviderTypes": ["abc123"]
}
}
}
removeWeldData
Example
Query
mutation removeWeldData($eid: String!) {
removeWeldData(eid: $eid)
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
mutation removeWeldData($eid: String!) {
removeWeldData(eid: $eid)
}
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{"data": {"removeWeldData": false}}
retryWebhookLog
Example
Query
mutation retryWebhookLog($eid: String!) {
retryWebhookLog(eid: $eid) {
id
eid
organization {
...OrganizationFragment
}
action
isError
isRetry
statusCode
millisecondsToFinish
objectEid
rootObjectType
rootObjectURL
objectMetadata
originalWebhookLog {
...WebhookLogFragment
}
createdAt
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
mutation retryWebhookLog($eid: String!) {
retryWebhookLog(eid: $eid) {
id
eid
organization {
...OrganizationFragment
}
action
isError
isRetry
statusCode
millisecondsToFinish
objectEid
rootObjectType
rootObjectURL
objectMetadata
originalWebhookLog {
...WebhookLogFragment
}
createdAt
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{
"data": {
"retryWebhookLog": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"organization": Organization,
"action": "xyz789",
"isError": false,
"isRetry": true,
"statusCode": 987,
"millisecondsToFinish": 987,
"objectEid": "kQp2qd9FVUWrrE60hMbi",
"rootObjectType": "xyz789",
"rootObjectURL": "https://domain.com/page.html",
"objectMetadata": {},
"originalWebhookLog": WebhookLog,
"createdAt": "2021-02-24T17:48:58.996Z"
}
}
}
sendEtchPacket
Example
Query
mutation sendEtchPacket($eid: String!) {
sendEtchPacket(eid: $eid) {
id
eid
name
organization {
...OrganizationFragment
}
documentGroup {
...DocumentGroupFragment
}
etchTemplate {
...EtchTemplateFragment
}
etchLogEvents {
...EtchLogFragment
}
userUploads {
...UserUploadFragment
}
isTest
payload
archivedAt
status
numberRemainingSigners
createdAt
updatedAt
detailsURL
webhookURL
webhookLogs {
...WebhookLogFragment
}
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
mutation sendEtchPacket($eid: String!) {
sendEtchPacket(eid: $eid) {
id
eid
name
organization {
...OrganizationFragment
}
documentGroup {
...DocumentGroupFragment
}
etchTemplate {
...EtchTemplateFragment
}
etchLogEvents {
...EtchLogFragment
}
userUploads {
...UserUploadFragment
}
isTest
payload
archivedAt
status
numberRemainingSigners
createdAt
updatedAt
detailsURL
webhookURL
webhookLogs {
...WebhookLogFragment
}
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{
"data": {
"sendEtchPacket": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "EtchPacket Name",
"organization": Organization,
"documentGroup": DocumentGroup,
"etchTemplate": EtchTemplate,
"etchLogEvents": [EtchLog],
"userUploads": [UserUpload],
"isTest": true,
"payload": {},
"archivedAt": "2020-08-24T17:48:58.759Z",
"status": "xyz789",
"numberRemainingSigners": 987,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"detailsURL": "https://domain.com/page.html",
"webhookURL": "https://domain.com/page.html",
"webhookLogs": [WebhookLog]
}
}
}
skipSigner
Example
Query
mutation skipSigner($signerEid: String!) {
skipSigner(signerEid: $signerEid) {
id
eid
status
provider
providerConfig
aliasId
name
email
routingOrder
documentGroup {
...DocumentGroupFragment
}
createdAt
updatedAt
finishURL
etchSignURL
user {
...UserFragment
}
signActionType
}
}
Variables
{
"signerEid": "kQp2qd9FVUWrrE60hMbi"
}
mutation skipSigner($signerEid: String!) {
skipSigner(signerEid: $signerEid) {
id
eid
status
provider
providerConfig
aliasId
name
email
routingOrder
documentGroup {
...DocumentGroupFragment
}
createdAt
updatedAt
finishURL
etchSignURL
user {
...UserFragment
}
signActionType
}
}
{
"signerEid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{
"data": {
"skipSigner": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"status": "xyz789",
"provider": "abc123",
"providerConfig": {},
"aliasId": "abc123",
"name": "Signer Name",
"email": "user@domain.com",
"routingOrder": 987,
"documentGroup": DocumentGroup,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"finishURL": "https://domain.com/page.html",
"etchSignURL": "https://domain.com/page.html",
"user": User,
"signActionType": "abc123"
}
}
}
updateCast
Cast
| Name | Description |
|---|---|
eid -
String!
|
|
name -
String
|
|
title -
String
|
|
config -
JSON
|
|
configFile -
Upload
|
|
file -
Upload
|
|
isArchived -
Boolean
|
Example
Query
mutation updateCast($eid: String!, $name: String, $title: String, $config: JSON, $configFile: Upload, $file: Upload, $isArchived: Boolean) {
updateCast(eid: $eid, name: $name, title: $title, config: $config, configFile: $configFile, file: $file, isArchived: $isArchived) {
id
eid
type
name
title
location
config(onlyKeys: $onlyKeys)
createdAt
updatedAt
organization {
...OrganizationFragment
}
versions {
...CastVersionFragment
}
archivedAt
fieldInfo
exampleData
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Cast Name",
"title": "Cast Title",
"config": {},
"configFile": Upload,
"file": Upload,
"isArchived": false
}
mutation updateCast($eid: String!, $name: String, $title: String, $config: JSON, $configFile: Upload, $file: Upload, $isArchived: Boolean) {
updateCast(eid: $eid, name: $name, title: $title, config: $config, configFile: $configFile, file: $file, isArchived: $isArchived) {
id
eid
type
name
title
location
config(onlyKeys: $onlyKeys)
createdAt
updatedAt
organization {
...OrganizationFragment
}
versions {
...CastVersionFragment
}
archivedAt
fieldInfo
exampleData
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Cast Name",
"title": "Cast Title",
"config": {},
"configFile": Upload,
"file": Upload,
"isArchived": false
}
Response
{
"data": {
"updateCast": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"type": "abc123",
"name": "Cast Name",
"title": "Cast Title",
"location": "xyz789",
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"organization": Organization,
"versions": [CastVersion],
"archivedAt": "2020-08-24T17:48:58.759Z",
"fieldInfo": {},
"exampleData": {}
}
}
}
updateEtchFree
EtchTemplate
| Name | Description |
|---|---|
etchTemplateEid -
String!
|
|
token -
String!
|
|
isEditing -
Boolean
|
|
name -
String
|
|
ownerName -
String
|
|
ownerEmail -
String
|
|
signers -
JSON
|
|
fields -
[JSON]
|
|
castFields -
[JSON]
|
Example
Query
mutation updateEtchFree($etchTemplateEid: String!, $token: String!, $isEditing: Boolean, $name: String, $ownerName: String, $ownerEmail: String, $signers: JSON, $fields: [JSON], $castFields: [JSON]) {
updateEtchFree(etchTemplateEid: $etchTemplateEid, token: $token, isEditing: $isEditing, name: $name, ownerName: $ownerName, ownerEmail: $ownerEmail, signers: $signers, fields: $fields, castFields: $castFields) {
id
eid
name
isRepeatable
config
organization {
...OrganizationFragment
}
casts {
...CastFragment
}
etchPackets {
...EtchPacketFragment
}
userUploads {
...UserUploadFragment
}
createdAt
updatedAt
}
}
Variables
{
"etchTemplateEid": "kQp2qd9FVUWrrE60hMbi",
"token": "abc123",
"isEditing": false,
"name": "EtchTemplate Name",
"ownerName": "xyz789",
"ownerEmail": "user@domain.com",
"signers": {},
"fields": [{}],
"castFields": [{}]
}
mutation updateEtchFree($etchTemplateEid: String!, $token: String!, $isEditing: Boolean, $name: String, $ownerName: String, $ownerEmail: String, $signers: JSON, $fields: [JSON], $castFields: [JSON]) {
updateEtchFree(etchTemplateEid: $etchTemplateEid, token: $token, isEditing: $isEditing, name: $name, ownerName: $ownerName, ownerEmail: $ownerEmail, signers: $signers, fields: $fields, castFields: $castFields) {
id
eid
name
isRepeatable
config
organization {
...OrganizationFragment
}
casts {
...CastFragment
}
etchPackets {
...EtchPacketFragment
}
userUploads {
...UserUploadFragment
}
createdAt
updatedAt
}
}
{
"etchTemplateEid": "kQp2qd9FVUWrrE60hMbi",
"token": "abc123",
"isEditing": false,
"name": "EtchTemplate Name",
"ownerName": "xyz789",
"ownerEmail": "user@domain.com",
"signers": {},
"fields": [{}],
"castFields": [{}]
}
Response
{
"data": {
"updateEtchFree": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "EtchTemplate Name",
"isRepeatable": false,
"config": {},
"organization": Organization,
"casts": [Cast],
"etchPackets": [EtchPacket],
"userUploads": [UserUpload],
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
}
}
updateEtchPacket
EtchPacket
| Name | Description |
|---|---|
eid -
String!
|
|
isArchived -
Boolean
|
|
name -
String
|
|
webhookURL -
String
|
Example
Query
mutation updateEtchPacket($eid: String!, $isArchived: Boolean, $name: String, $webhookURL: String) {
updateEtchPacket(eid: $eid, isArchived: $isArchived, name: $name, webhookURL: $webhookURL) {
id
eid
name
organization {
...OrganizationFragment
}
documentGroup {
...DocumentGroupFragment
}
etchTemplate {
...EtchTemplateFragment
}
etchLogEvents {
...EtchLogFragment
}
userUploads {
...UserUploadFragment
}
isTest
payload
archivedAt
status
numberRemainingSigners
createdAt
updatedAt
detailsURL
webhookURL
webhookLogs {
...WebhookLogFragment
}
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"isArchived": true,
"name": "EtchPacket Name",
"webhookURL": "https://domain.com/page.html"
}
mutation updateEtchPacket($eid: String!, $isArchived: Boolean, $name: String, $webhookURL: String) {
updateEtchPacket(eid: $eid, isArchived: $isArchived, name: $name, webhookURL: $webhookURL) {
id
eid
name
organization {
...OrganizationFragment
}
documentGroup {
...DocumentGroupFragment
}
etchTemplate {
...EtchTemplateFragment
}
etchLogEvents {
...EtchLogFragment
}
userUploads {
...UserUploadFragment
}
isTest
payload
archivedAt
status
numberRemainingSigners
createdAt
updatedAt
detailsURL
webhookURL
webhookLogs {
...WebhookLogFragment
}
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"isArchived": true,
"name": "EtchPacket Name",
"webhookURL": "https://domain.com/page.html"
}
Response
{
"data": {
"updateEtchPacket": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "EtchPacket Name",
"organization": Organization,
"documentGroup": DocumentGroup,
"etchTemplate": EtchTemplate,
"etchLogEvents": [EtchLog],
"userUploads": [UserUpload],
"isTest": true,
"payload": {},
"archivedAt": "2020-08-24T17:48:58.759Z",
"status": "abc123",
"numberRemainingSigners": 123,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"detailsURL": "https://domain.com/page.html",
"webhookURL": "https://domain.com/page.html",
"webhookLogs": [WebhookLog]
}
}
}
updateEtchTemplate
EtchTemplate
| Name | Description |
|---|---|
eid -
String!
|
|
isRepeatable -
Boolean
|
|
name -
String
|
|
config -
JSON
|
Example
Query
mutation updateEtchTemplate($eid: String!, $isRepeatable: Boolean, $name: String, $config: JSON) {
updateEtchTemplate(eid: $eid, isRepeatable: $isRepeatable, name: $name, config: $config) {
id
eid
name
isRepeatable
config
organization {
...OrganizationFragment
}
casts {
...CastFragment
}
etchPackets {
...EtchPacketFragment
}
userUploads {
...UserUploadFragment
}
createdAt
updatedAt
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"isRepeatable": true,
"name": "EtchTemplate Name",
"config": {}
}
mutation updateEtchTemplate($eid: String!, $isRepeatable: Boolean, $name: String, $config: JSON) {
updateEtchTemplate(eid: $eid, isRepeatable: $isRepeatable, name: $name, config: $config) {
id
eid
name
isRepeatable
config
organization {
...OrganizationFragment
}
casts {
...CastFragment
}
etchPackets {
...EtchPacketFragment
}
userUploads {
...UserUploadFragment
}
createdAt
updatedAt
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"isRepeatable": true,
"name": "EtchTemplate Name",
"config": {}
}
Response
{
"data": {
"updateEtchTemplate": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "EtchTemplate Name",
"isRepeatable": true,
"config": {},
"organization": Organization,
"casts": [Cast],
"etchPackets": [EtchPacket],
"userUploads": [UserUpload],
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
}
}
updateForge
Forge
| Name | Description |
|---|---|
eid -
String!
|
|
name -
String
|
|
slug -
String
|
|
config -
JSON
|
|
configFile -
Upload
|
|
isArchived -
Boolean
|
|
isRequired -
Boolean
|
|
title -
String
|
|
organizationRole -
String
|
|
unauthenticatedAuthType -
String
|
Example
Query
mutation updateForge($eid: String!, $name: String, $slug: String, $config: JSON, $configFile: Upload, $isArchived: Boolean, $isRequired: Boolean, $title: String, $organizationRole: String, $unauthenticatedAuthType: String) {
updateForge(eid: $eid, name: $name, slug: $slug, config: $config, configFile: $configFile, isArchived: $isArchived, isRequired: $isRequired, title: $title, organizationRole: $organizationRole, unauthenticatedAuthType: $unauthenticatedAuthType) {
id
eid
name
slug
config(onlyKeys: $onlyKeys)
fieldInfo
weld {
...WeldFragment
}
organization {
...OrganizationFragment
}
userUploads {
...UserUploadFragment
}
createdAt
updatedAt
versions {
...ForgeVersionFragment
}
archivedAt
isRequired
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Forge Name",
"slug": "forge-name",
"config": {},
"configFile": Upload,
"isArchived": false,
"isRequired": true,
"title": "Forge Title",
"organizationRole": "xyz789",
"unauthenticatedAuthType": "xyz789"
}
mutation updateForge($eid: String!, $name: String, $slug: String, $config: JSON, $configFile: Upload, $isArchived: Boolean, $isRequired: Boolean, $title: String, $organizationRole: String, $unauthenticatedAuthType: String) {
updateForge(eid: $eid, name: $name, slug: $slug, config: $config, configFile: $configFile, isArchived: $isArchived, isRequired: $isRequired, title: $title, organizationRole: $organizationRole, unauthenticatedAuthType: $unauthenticatedAuthType) {
id
eid
name
slug
config(onlyKeys: $onlyKeys)
fieldInfo
weld {
...WeldFragment
}
organization {
...OrganizationFragment
}
userUploads {
...UserUploadFragment
}
createdAt
updatedAt
versions {
...ForgeVersionFragment
}
archivedAt
isRequired
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Forge Name",
"slug": "forge-name",
"config": {},
"configFile": Upload,
"isArchived": false,
"isRequired": true,
"title": "Forge Title",
"organizationRole": "xyz789",
"unauthenticatedAuthType": "xyz789"
}
Response
{
"data": {
"updateForge": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Forge Name",
"slug": "forge-name",
"config": {},
"fieldInfo": {},
"weld": Weld,
"organization": Organization,
"userUploads": [UserUpload],
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"versions": [ForgeVersion],
"archivedAt": "2021-02-24T17:48:58.759Z",
"isRequired": false
}
}
}
updateOrganization
Organization
| Name | Description |
|---|---|
organizationSlug -
String!
|
|
isInternal -
Boolean
|
|
useTestSignatureProvider -
Boolean
|
|
name -
String
|
|
logo -
Upload
|
|
billingEmail -
String
|
|
slug -
String
|
|
defaultSourceId -
String
|
|
signatureProvider -
String
|
|
config -
JSON
|
|
trialExpiresIn -
Int
|
|
usePDFFillingAPI -
Boolean
|
Example
Query
mutation updateOrganization($organizationSlug: String!, $isInternal: Boolean, $useTestSignatureProvider: Boolean, $name: String, $logo: Upload, $billingEmail: String, $slug: String, $defaultSourceId: String, $signatureProvider: String, $config: JSON, $trialExpiresIn: Int, $usePDFFillingAPI: Boolean) {
updateOrganization(organizationSlug: $organizationSlug, isInternal: $isInternal, useTestSignatureProvider: $useTestSignatureProvider, name: $name, logo: $logo, billingEmail: $billingEmail, slug: $slug, defaultSourceId: $defaultSourceId, signatureProvider: $signatureProvider, config: $config, trialExpiresIn: $trialExpiresIn, usePDFFillingAPI: $usePDFFillingAPI) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
Variables
{
"organizationSlug": "organization-slug",
"isInternal": true,
"useTestSignatureProvider": true,
"name": "Organization Name",
"logo": Upload,
"billingEmail": "user@domain.com",
"slug": "organization-name",
"defaultSourceId": "xyz789",
"signatureProvider": "xyz789",
"config": {},
"trialExpiresIn": 123,
"usePDFFillingAPI": false
}
mutation updateOrganization($organizationSlug: String!, $isInternal: Boolean, $useTestSignatureProvider: Boolean, $name: String, $logo: Upload, $billingEmail: String, $slug: String, $defaultSourceId: String, $signatureProvider: String, $config: JSON, $trialExpiresIn: Int, $usePDFFillingAPI: Boolean) {
updateOrganization(organizationSlug: $organizationSlug, isInternal: $isInternal, useTestSignatureProvider: $useTestSignatureProvider, name: $name, logo: $logo, billingEmail: $billingEmail, slug: $slug, defaultSourceId: $defaultSourceId, signatureProvider: $signatureProvider, config: $config, trialExpiresIn: $trialExpiresIn, usePDFFillingAPI: $usePDFFillingAPI) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
{
"organizationSlug": "organization-slug",
"isInternal": true,
"useTestSignatureProvider": true,
"name": "Organization Name",
"logo": Upload,
"billingEmail": "user@domain.com",
"slug": "organization-name",
"defaultSourceId": "xyz789",
"signatureProvider": "xyz789",
"config": {},
"trialExpiresIn": 123,
"usePDFFillingAPI": false
}
Response
{
"data": {
"updateOrganization": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Organization Name",
"logo": {},
"logoURL": "https://domain.com/page.html",
"parentOrganization": Organization,
"billingEmail": "user@domain.com",
"slug": "organization-name",
"users": [User],
"organizationUsers": [OrganizationUser],
"organizationUserInvites": [OrganizationUserInvite],
"isPersonal": false,
"isInternal": true,
"isSubscribed": "xyz789",
"useTestSignatureProvider": true,
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"welds": [Weld],
"etchTemplates": [EtchTemplate],
"etchPackets": EtchPacketPage,
"weldGroups": [WeldGroup],
"forges": [Forge],
"forgeMaps": [ForgeMap],
"casts": [Cast],
"paymentMethods": [PaymentMethod],
"webhook": Webhook,
"webhookLogs": WebhookLogPage,
"childOrganizations": [Organization],
"subscribedPlanFeatures": {},
"subscriptionActivity": {},
"currentInvoice": Invoice,
"totalUsedUnits": 123,
"weldCompleteWebhookStats": {},
"weldCompleteStats": {},
"etchCompleteStats": {},
"remainingSubmissions": {},
"remainingEtchCompletions": {},
"signatureProviderType": "abc123",
"availableSignatureProviderTypes": ["xyz789"]
}
}
}
updateOrganizationUser
Example
Query
mutation updateOrganizationUser($role: String!, $organizationEid: String!, $userEid: String!) {
updateOrganizationUser(role: $role, organizationEid: $organizationEid, userEid: $userEid) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
Variables
{
"role": "abc123",
"organizationEid": "kQp2qd9FVUWrrE60hMbi",
"userEid": "kQp2qd9FVUWrrE60hMbi"
}
mutation updateOrganizationUser($role: String!, $organizationEid: String!, $userEid: String!) {
updateOrganizationUser(role: $role, organizationEid: $organizationEid, userEid: $userEid) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
{
"role": "abc123",
"organizationEid": "kQp2qd9FVUWrrE60hMbi",
"userEid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{
"data": {
"updateOrganizationUser": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Organization Name",
"logo": {},
"logoURL": "https://domain.com/page.html",
"parentOrganization": Organization,
"billingEmail": "user@domain.com",
"slug": "organization-name",
"users": [User],
"organizationUsers": [OrganizationUser],
"organizationUserInvites": [OrganizationUserInvite],
"isPersonal": true,
"isInternal": false,
"isSubscribed": "xyz789",
"useTestSignatureProvider": true,
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"welds": [Weld],
"etchTemplates": [EtchTemplate],
"etchPackets": EtchPacketPage,
"weldGroups": [WeldGroup],
"forges": [Forge],
"forgeMaps": [ForgeMap],
"casts": [Cast],
"paymentMethods": [PaymentMethod],
"webhook": Webhook,
"webhookLogs": WebhookLogPage,
"childOrganizations": [Organization],
"subscribedPlanFeatures": {},
"subscriptionActivity": {},
"currentInvoice": Invoice,
"totalUsedUnits": 987,
"weldCompleteWebhookStats": {},
"weldCompleteStats": {},
"etchCompleteStats": {},
"remainingSubmissions": {},
"remainingEtchCompletions": {},
"signatureProviderType": "xyz789",
"availableSignatureProviderTypes": ["xyz789"]
}
}
}
updateSubmission
Example
Query
mutation updateSubmission($eid: String!, $isExcluded: Boolean) {
updateSubmission(eid: $eid, isExcluded: $isExcluded) {
id
eid
payload
payloadValue
requestMeta
currentStep
totalSteps
continueURL
user {
...UserFragment
}
forge {
...ForgeFragment
}
signer {
...SignerFragment
}
weldData {
...WeldDataFragment
}
completedAt
reviewData
completionPercentage
touchedByUser
isExcluded
status
createdAt
updatedAt
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"isExcluded": true
}
mutation updateSubmission($eid: String!, $isExcluded: Boolean) {
updateSubmission(eid: $eid, isExcluded: $isExcluded) {
id
eid
payload
payloadValue
requestMeta
currentStep
totalSteps
continueURL
user {
...UserFragment
}
forge {
...ForgeFragment
}
signer {
...SignerFragment
}
weldData {
...WeldDataFragment
}
completedAt
reviewData
completionPercentage
touchedByUser
isExcluded
status
createdAt
updatedAt
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"isExcluded": true
}
Response
{
"data": {
"updateSubmission": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"payload": {},
"payloadValue": {},
"requestMeta": {},
"currentStep": 987,
"totalSteps": 123,
"continueURL": "https://domain.com/page.html",
"user": User,
"forge": Forge,
"signer": Signer,
"weldData": WeldData,
"completedAt": "2021-02-24T17:48:58.759Z",
"reviewData": {},
"completionPercentage": 33.33,
"touchedByUser": true,
"isExcluded": true,
"status": "abc123",
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
}
}
updateWebhook
Example
Query
mutation updateWebhook($eid: String!, $url: String) {
updateWebhook(eid: $eid, url: $url) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"url": "https://domain.com/page.html"
}
mutation updateWebhook($eid: String!, $url: String) {
updateWebhook(eid: $eid, url: $url) {
id
eid
name
logo
logoURL
parentOrganization {
...OrganizationFragment
}
billingEmail
slug
users {
...UserFragment
}
organizationUsers {
...OrganizationUserFragment
}
organizationUserInvites {
...OrganizationUserInviteFragment
}
isPersonal
isInternal
isSubscribed
useTestSignatureProvider
config
createdAt
updatedAt
welds(visibility: $visibility, isArchived: $isArchived) {
...WeldFragment
}
etchTemplates {
...EtchTemplateFragment
}
etchPackets(status: $status, isTest: $isTest, isArchived: $isArchived, limit: $limit, offset: $offset) {
...EtchPacketPageFragment
}
weldGroups {
...WeldGroupFragment
}
forges(isArchived: $isArchived) {
...ForgeFragment
}
forgeMaps {
...ForgeMapFragment
}
casts(isArchived: $isArchived) {
...CastFragment
}
paymentMethods {
...PaymentMethodFragment
}
webhook {
...WebhookFragment
}
webhookLogs(limit: $limit, offset: $offset) {
...WebhookLogPageFragment
}
childOrganizations {
...OrganizationFragment
}
subscribedPlanFeatures
subscriptionActivity
currentInvoice {
...InvoiceFragment
}
totalUsedUnits
weldCompleteWebhookStats
weldCompleteStats
etchCompleteStats
remainingSubmissions
remainingEtchCompletions
signatureProviderType
availableSignatureProviderTypes
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"url": "https://domain.com/page.html"
}
Response
{
"data": {
"updateWebhook": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Organization Name",
"logo": {},
"logoURL": "https://domain.com/page.html",
"parentOrganization": Organization,
"billingEmail": "user@domain.com",
"slug": "organization-name",
"users": [User],
"organizationUsers": [OrganizationUser],
"organizationUserInvites": [OrganizationUserInvite],
"isPersonal": true,
"isInternal": true,
"isSubscribed": "abc123",
"useTestSignatureProvider": false,
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"welds": [Weld],
"etchTemplates": [EtchTemplate],
"etchPackets": EtchPacketPage,
"weldGroups": [WeldGroup],
"forges": [Forge],
"forgeMaps": [ForgeMap],
"casts": [Cast],
"paymentMethods": [PaymentMethod],
"webhook": Webhook,
"webhookLogs": WebhookLogPage,
"childOrganizations": [Organization],
"subscribedPlanFeatures": {},
"subscriptionActivity": {},
"currentInvoice": Invoice,
"totalUsedUnits": 987,
"weldCompleteWebhookStats": {},
"weldCompleteStats": {},
"etchCompleteStats": {},
"remainingSubmissions": {},
"remainingEtchCompletions": {},
"signatureProviderType": "xyz789",
"availableSignatureProviderTypes": ["xyz789"]
}
}
}
updateWeld
Weld
| Name | Description |
|---|---|
eid -
String!
|
|
name -
String
|
|
slug -
String
|
|
visibility -
String
|
|
config -
JSON
|
|
configFile -
Upload
|
|
isArchived -
Boolean
|
|
expiresAt -
String
|
|
draftStep -
String
|
|
entryForgeId -
Int
|
|
entryButtonText -
String
|
|
entryButtonCopyLink -
Boolean
|
|
signatureEmailSubject -
JSON
|
|
signatureEmailBody -
JSON
|
|
dataDisplayTitle -
JSON
|
|
signatureProvider -
String
|
|
lockedTitleNew -
String
|
|
lockedDescriptionNew -
String
|
|
lockedTitleExisting -
String
|
|
lockedDescriptionExisting -
String
|
|
expireAfterDaysComplete -
Int
|
|
expireAfterDaysStart -
Int
|
|
planEid -
String
|
Example
Query
mutation updateWeld($eid: String!, $name: String, $slug: String, $visibility: String, $config: JSON, $configFile: Upload, $isArchived: Boolean, $expiresAt: String, $draftStep: String, $entryForgeId: Int, $entryButtonText: String, $entryButtonCopyLink: Boolean, $signatureEmailSubject: JSON, $signatureEmailBody: JSON, $dataDisplayTitle: JSON, $signatureProvider: String, $lockedTitleNew: String, $lockedDescriptionNew: String, $lockedTitleExisting: String, $lockedDescriptionExisting: String, $expireAfterDaysComplete: Int, $expireAfterDaysStart: Int, $planEid: String) {
updateWeld(eid: $eid, name: $name, slug: $slug, visibility: $visibility, config: $config, configFile: $configFile, isArchived: $isArchived, expiresAt: $expiresAt, draftStep: $draftStep, entryForgeId: $entryForgeId, entryButtonText: $entryButtonText, entryButtonCopyLink: $entryButtonCopyLink, signatureEmailSubject: $signatureEmailSubject, signatureEmailBody: $signatureEmailBody, dataDisplayTitle: $dataDisplayTitle, signatureProvider: $signatureProvider, lockedTitleNew: $lockedTitleNew, lockedDescriptionNew: $lockedDescriptionNew, lockedTitleExisting: $lockedTitleExisting, lockedDescriptionExisting: $lockedDescriptionExisting, expireAfterDaysComplete: $expireAfterDaysComplete, expireAfterDaysStart: $expireAfterDaysStart, planEid: $planEid) {
id
eid
slug
name
title
visibility
config(onlyKeys: $onlyKeys)
organization {
...OrganizationFragment
}
createdAt
updatedAt
isTest
hasSigners
forges(isArchived: $isArchived) {
...ForgeFragment
}
casts {
...CastFragment
}
versions {
...WeldVersionFragment
}
weldGroups {
...WeldGroupFragment
}
weldDatas(touchedByUser: $touchedByUser, ignoreTest: $ignoreTest, isTest: $isTest, isArchived: $isArchived, statuses: $statuses, fromDate: $fromDate, toDate: $toDate, simpleSearchTerm: $simpleSearchTerm, limit: $limit, offset: $offset) {
...WeldDataPageFragment
}
hasWeldDatas
weldDataCounts
archivedAt
expiresAt
draftStep
signatureProviderType
availableSignatureProviderTypes
remainingSubmissions
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Weld Name",
"slug": "weld-name",
"visibility": "xyz789",
"config": {},
"configFile": Upload,
"isArchived": false,
"expiresAt": "abc123",
"draftStep": "xyz789",
"entryForgeId": 123,
"entryButtonText": "abc123",
"entryButtonCopyLink": false,
"signatureEmailSubject": {},
"signatureEmailBody": {},
"dataDisplayTitle": {},
"signatureProvider": "xyz789",
"lockedTitleNew": "abc123",
"lockedDescriptionNew": "abc123",
"lockedTitleExisting": "abc123",
"lockedDescriptionExisting": "xyz789",
"expireAfterDaysComplete": 987,
"expireAfterDaysStart": 123,
"planEid": "kQp2qd9FVUWrrE60hMbi"
}
mutation updateWeld($eid: String!, $name: String, $slug: String, $visibility: String, $config: JSON, $configFile: Upload, $isArchived: Boolean, $expiresAt: String, $draftStep: String, $entryForgeId: Int, $entryButtonText: String, $entryButtonCopyLink: Boolean, $signatureEmailSubject: JSON, $signatureEmailBody: JSON, $dataDisplayTitle: JSON, $signatureProvider: String, $lockedTitleNew: String, $lockedDescriptionNew: String, $lockedTitleExisting: String, $lockedDescriptionExisting: String, $expireAfterDaysComplete: Int, $expireAfterDaysStart: Int, $planEid: String) {
updateWeld(eid: $eid, name: $name, slug: $slug, visibility: $visibility, config: $config, configFile: $configFile, isArchived: $isArchived, expiresAt: $expiresAt, draftStep: $draftStep, entryForgeId: $entryForgeId, entryButtonText: $entryButtonText, entryButtonCopyLink: $entryButtonCopyLink, signatureEmailSubject: $signatureEmailSubject, signatureEmailBody: $signatureEmailBody, dataDisplayTitle: $dataDisplayTitle, signatureProvider: $signatureProvider, lockedTitleNew: $lockedTitleNew, lockedDescriptionNew: $lockedDescriptionNew, lockedTitleExisting: $lockedTitleExisting, lockedDescriptionExisting: $lockedDescriptionExisting, expireAfterDaysComplete: $expireAfterDaysComplete, expireAfterDaysStart: $expireAfterDaysStart, planEid: $planEid) {
id
eid
slug
name
title
visibility
config(onlyKeys: $onlyKeys)
organization {
...OrganizationFragment
}
createdAt
updatedAt
isTest
hasSigners
forges(isArchived: $isArchived) {
...ForgeFragment
}
casts {
...CastFragment
}
versions {
...WeldVersionFragment
}
weldGroups {
...WeldGroupFragment
}
weldDatas(touchedByUser: $touchedByUser, ignoreTest: $ignoreTest, isTest: $isTest, isArchived: $isArchived, statuses: $statuses, fromDate: $fromDate, toDate: $toDate, simpleSearchTerm: $simpleSearchTerm, limit: $limit, offset: $offset) {
...WeldDataPageFragment
}
hasWeldDatas
weldDataCounts
archivedAt
expiresAt
draftStep
signatureProviderType
availableSignatureProviderTypes
remainingSubmissions
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Weld Name",
"slug": "weld-name",
"visibility": "xyz789",
"config": {},
"configFile": Upload,
"isArchived": false,
"expiresAt": "abc123",
"draftStep": "xyz789",
"entryForgeId": 123,
"entryButtonText": "abc123",
"entryButtonCopyLink": false,
"signatureEmailSubject": {},
"signatureEmailBody": {},
"dataDisplayTitle": {},
"signatureProvider": "xyz789",
"lockedTitleNew": "abc123",
"lockedDescriptionNew": "abc123",
"lockedTitleExisting": "abc123",
"lockedDescriptionExisting": "xyz789",
"expireAfterDaysComplete": 987,
"expireAfterDaysStart": 123,
"planEid": "kQp2qd9FVUWrrE60hMbi"
}
Response
{
"data": {
"updateWeld": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"slug": "weld-name",
"name": "Weld Name",
"title": "Weld Title",
"visibility": "xyz789",
"config": {},
"organization": Organization,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"isTest": false,
"hasSigners": false,
"forges": [Forge],
"casts": [Cast],
"versions": [WeldVersion],
"weldGroups": [WeldGroup],
"weldDatas": WeldDataPage,
"hasWeldDatas": true,
"weldDataCounts": {},
"archivedAt": "2020-08-24T17:48:58.759Z",
"expiresAt": "2021-02-24T17:48:58.759Z",
"draftStep": "xyz789",
"signatureProviderType": "xyz789",
"availableSignatureProviderTypes": ["abc123"],
"remainingSubmissions": {}
}
}
}
updateWeldData
WeldData
| Name | Description |
|---|---|
eid -
String!
|
|
isTest -
Boolean
|
|
isArchived -
Boolean
|
|
isExpired -
Boolean
|
|
pin -
String
|
|
webhookURL -
String
|
Example
Query
mutation updateWeldData($eid: String!, $isTest: Boolean, $isArchived: Boolean, $isExpired: Boolean, $pin: String, $webhookURL: String) {
updateWeldData(eid: $eid, isTest: $isTest, isArchived: $isArchived, isExpired: $isExpired, pin: $pin, webhookURL: $webhookURL) {
id
eid
weld {
...WeldFragment
}
weldDataGroup {
...WeldDataGroupFragment
}
submissions {
...SubmissionFragment
}
isComplete
isExpired
isCompleteAndSigned
isTest
hasSigners
forgesRequiringCompletion {
...ForgeFragment
}
displayTitle
dataUpdatedAt
documentGroup {
...DocumentGroupFragment
}
continueURL
webhookURL
createdAt
updatedAt
expiresAt
status
payloadCanBeUpdated
completionPercentage
numberRemainingSigners
nextSigner {
...SignerFragment
}
archivedAt
files
excludedFiles
agents
pin
webhookLogs {
...WebhookLogFragment
}
etchLogEvents {
...EtchLogFragment
}
weldDataLogEvents {
...WeldDataLogFragment
}
userUploads {
...UserUploadFragment
}
}
}
Variables
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"isTest": true,
"isArchived": true,
"isExpired": false,
"pin": "9876",
"webhookURL": "https://domain.com/page.html"
}
mutation updateWeldData($eid: String!, $isTest: Boolean, $isArchived: Boolean, $isExpired: Boolean, $pin: String, $webhookURL: String) {
updateWeldData(eid: $eid, isTest: $isTest, isArchived: $isArchived, isExpired: $isExpired, pin: $pin, webhookURL: $webhookURL) {
id
eid
weld {
...WeldFragment
}
weldDataGroup {
...WeldDataGroupFragment
}
submissions {
...SubmissionFragment
}
isComplete
isExpired
isCompleteAndSigned
isTest
hasSigners
forgesRequiringCompletion {
...ForgeFragment
}
displayTitle
dataUpdatedAt
documentGroup {
...DocumentGroupFragment
}
continueURL
webhookURL
createdAt
updatedAt
expiresAt
status
payloadCanBeUpdated
completionPercentage
numberRemainingSigners
nextSigner {
...SignerFragment
}
archivedAt
files
excludedFiles
agents
pin
webhookLogs {
...WebhookLogFragment
}
etchLogEvents {
...EtchLogFragment
}
weldDataLogEvents {
...WeldDataLogFragment
}
userUploads {
...UserUploadFragment
}
}
}
{
"eid": "kQp2qd9FVUWrrE60hMbi",
"isTest": true,
"isArchived": true,
"isExpired": false,
"pin": "9876",
"webhookURL": "https://domain.com/page.html"
}
Response
{
"data": {
"updateWeldData": {
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"weld": Weld,
"weldDataGroup": WeldDataGroup,
"submissions": [Submission],
"isComplete": false,
"isExpired": false,
"isCompleteAndSigned": true,
"isTest": false,
"hasSigners": false,
"forgesRequiringCompletion": [Forge],
"displayTitle": "abc123",
"dataUpdatedAt": "2020-08-24T17:48:58.759Z",
"documentGroup": DocumentGroup,
"continueURL": "https://domain.com/page.html",
"webhookURL": "https://domain.com/page.html",
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"expiresAt": "2021-02-24T17:48:58.759Z",
"status": "abc123",
"payloadCanBeUpdated": false,
"completionPercentage": "abc123",
"numberRemainingSigners": 987,
"nextSigner": Signer,
"archivedAt": "2021-02-24T17:48:58.759Z",
"files": [{}],
"excludedFiles": [{}],
"agents": {},
"pin": "9876",
"webhookLogs": [WebhookLog],
"etchLogEvents": [EtchLog],
"weldDataLogEvents": [WeldDataLog],
"userUploads": [UserUpload]
}
}
}
voidDocumentGroup
Example
Query
mutation voidDocumentGroup($weldDataEid: String, $eid: String, $voidedReason: String!) {
voidDocumentGroup(weldDataEid: $weldDataEid, eid: $eid, voidedReason: $voidedReason) {
id
eid
status
provider
weldData {
...WeldDataFragment
}
etchPacket {
...EtchPacketFragment
}
signers {
...SignerFragment
}
currentRoutingStep
providerConfig
files
finishPageConfig
signaturePageConfig
createdAt
updatedAt
downloadZipURL
}
}
Variables
{
"weldDataEid": "kQp2qd9FVUWrrE60hMbi",
"eid": "kQp2qd9FVUWrrE60hMbi",
"voidedReason": "abc123"
}
mutation voidDocumentGroup($weldDataEid: String, $eid: String, $voidedReason: String!) {
voidDocumentGroup(weldDataEid: $weldDataEid, eid: $eid, voidedReason: $voidedReason) {
id
eid
status
provider
weldData {
...WeldDataFragment
}
etchPacket {
...EtchPacketFragment
}
signers {
...SignerFragment
}
currentRoutingStep
providerConfig
files
finishPageConfig
signaturePageConfig
createdAt
updatedAt
downloadZipURL
}
}
{
"weldDataEid": "kQp2qd9FVUWrrE60hMbi",
"eid": "kQp2qd9FVUWrrE60hMbi",
"voidedReason": "abc123"
}
Response
{
"data": {
"voidDocumentGroup": {
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"status": "abc123",
"provider": "abc123",
"weldData": WeldData,
"etchPacket": EtchPacket,
"signers": [Signer],
"currentRoutingStep": 123,
"providerConfig": {},
"files": [{}],
"finishPageConfig": {},
"signaturePageConfig": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"downloadZipURL": "https://domain.com/page.html"
}
}
}
Types
Cast
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
type -
String
|
|
name -
String
|
|
title -
String
|
|
location -
String
|
|
config -
JSON
|
|
|
Arguments |
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
organization -
Organization
|
|
versions -
[CastVersion]
|
|
archivedAt -
Date
|
|
fieldInfo -
JSON
|
|
exampleData -
JSON
|
|
Example
{
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"type": "abc123",
"name": "Cast Name",
"title": "Cast Title",
"location": "xyz789",
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"organization": Organization,
"versions": [CastVersion],
"archivedAt": "2021-02-24T17:48:58.759Z",
"fieldInfo": {},
"exampleData": {}
}
CastPage
| Name | Description |
|---|---|
rowCount -
Int
|
Total number of rows found for the query before pagination |
pageCount -
Int
|
Total number of pages of results |
page -
Int
|
The requested page number |
pageSize -
Int
|
The requested number of rows per page |
items -
[Cast]
|
The actual records for the requested page |
Example
{
"rowCount": 20,
"pageCount": 2,
"page": 1,
"pageSize": 10,
"items": [Cast]
}
CastVersion
| Name | Description |
|---|---|
id -
Int!
|
|
updatedColumns -
[String]
|
|
name -
String
|
|
type -
String
|
|
title -
String
|
|
location -
String
|
|
config -
JSON
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
user -
User
|
Example
{
"id": 123,
"updatedColumns": ["abc123"],
"name": "CastVersion Name",
"type": "abc123",
"title": "CastVersion Title",
"location": "xyz789",
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"user": User
}
DocumentGroup
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
status -
String
|
|
provider -
String
|
|
weldData -
WeldData
|
|
etchPacket -
EtchPacket
|
|
signers -
[Signer]
|
|
currentRoutingStep -
Int
|
|
providerConfig -
JSON
|
|
files -
[JSON]
|
|
finishPageConfig -
JSON
|
|
signaturePageConfig -
JSON
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
downloadZipURL -
String
|
Example
{
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"status": "abc123",
"provider": "abc123",
"weldData": WeldData,
"etchPacket": EtchPacket,
"signers": [Signer],
"currentRoutingStep": 987,
"providerConfig": {},
"files": [{}],
"finishPageConfig": {},
"signaturePageConfig": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"downloadZipURL": "https://domain.com/page.html"
}
DocumentGroupPage
| Name | Description |
|---|---|
rowCount -
Int
|
Total number of rows found for the query before pagination |
pageCount -
Int
|
Total number of pages of results |
page -
Int
|
The requested page number |
pageSize -
Int
|
The requested number of rows per page |
items -
[DocumentGroup]
|
The actual records for the requested page |
Example
{
"rowCount": 20,
"pageCount": 2,
"page": 1,
"pageSize": 10,
"items": [DocumentGroup]
}
EtchLog
| Name | Description |
|---|---|
id -
Int!
|
|
signer -
Signer
|
|
user -
User
|
|
action -
String
|
|
formattedLocation -
String
|
|
createdAt -
Date
|
|
fileId -
String
|
|
metadata -
JSON
|
Example
{
"id": 123,
"signer": Signer,
"user": User,
"action": "abc123",
"formattedLocation": "xyz789",
"createdAt": "2021-02-24T17:48:58.996Z",
"fileId": "abc123",
"metadata": {}
}
EtchPacket
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
name -
String
|
|
organization -
Organization
|
|
documentGroup -
DocumentGroup
|
|
etchTemplate -
EtchTemplate
|
|
etchLogEvents -
[EtchLog]
|
|
userUploads -
[UserUpload]
|
|
isTest -
Boolean
|
|
payload -
JSON
|
|
archivedAt -
Date
|
|
status -
String
|
|
numberRemainingSigners -
Int
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
detailsURL -
String
|
|
webhookURL -
String
|
|
webhookLogs -
[WebhookLog]
|
Example
{
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "EtchPacket Name",
"organization": Organization,
"documentGroup": DocumentGroup,
"etchTemplate": EtchTemplate,
"etchLogEvents": [EtchLog],
"userUploads": [UserUpload],
"isTest": false,
"payload": {},
"archivedAt": "2020-08-24T17:48:58.759Z",
"status": "abc123",
"numberRemainingSigners": 987,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"detailsURL": "https://domain.com/page.html",
"webhookURL": "https://domain.com/page.html",
"webhookLogs": [WebhookLog]
}
EtchPacketPage
| Name | Description |
|---|---|
rowCount -
Int
|
Total number of rows found for the query before pagination |
pageCount -
Int
|
Total number of pages of results |
page -
Int
|
The requested page number |
pageSize -
Int
|
The requested number of rows per page |
items -
[EtchPacket]
|
The actual records for the requested page |
Example
{
"rowCount": 20,
"pageCount": 2,
"page": 1,
"pageSize": 10,
"items": [EtchPacket]
}
EtchTemplate
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
name -
String
|
|
isRepeatable -
Boolean
|
|
config -
JSON
|
|
organization -
Organization
|
|
casts -
[Cast]
|
|
etchPackets -
[EtchPacket]
|
|
userUploads -
[UserUpload]
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
Example
{
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "EtchTemplate Name",
"isRepeatable": true,
"config": {},
"organization": Organization,
"casts": [Cast],
"etchPackets": [EtchPacket],
"userUploads": [UserUpload],
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
Float
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
987.65
Forge
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
name -
String
|
|
slug -
String
|
|
config -
JSON
|
|
|
Arguments
|
|
fieldInfo -
JSON
|
|
weld -
Weld
|
|
organization -
Organization
|
|
userUploads -
[UserUpload]
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
versions -
[ForgeVersion]
|
|
archivedAt -
Date
|
|
isRequired -
Boolean
|
|
Example
{
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Forge Name",
"slug": "forge-name",
"config": {},
"fieldInfo": {},
"weld": Weld,
"organization": Organization,
"userUploads": [UserUpload],
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"versions": [ForgeVersion],
"archivedAt": "2020-08-24T17:48:58.759Z",
"isRequired": true
}
ForgeMap
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
forgeA -
Forge
|
|
forgeB -
Forge
|
|
config -
JSON
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
Example
{
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"forgeA": Forge,
"forgeB": Forge,
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
ForgePage
| Name | Description |
|---|---|
rowCount -
Int
|
Total number of rows found for the query before pagination |
pageCount -
Int
|
Total number of pages of results |
page -
Int
|
The requested page number |
pageSize -
Int
|
The requested number of rows per page |
items -
[Forge]
|
The actual records for the requested page |
Example
{
"rowCount": 20,
"pageCount": 2,
"page": 1,
"pageSize": 10,
"items": [Forge]
}
ForgeVersion
| Name | Description |
|---|---|
id -
Int!
|
|
updatedColumns -
[String]
|
|
name -
String
|
|
slug -
String
|
|
config -
JSON
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
user -
User
|
Example
{
"id": 987,
"updatedColumns": ["abc123"],
"name": "ForgeVersion Name",
"slug": "forgeversion-name",
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"user": User
}
Int
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
Organization
An entity that encapsulates a set of workflows, templates, users, etc.
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
name -
String
|
|
logo -
JSON
|
|
logoURL -
String
|
|
parentOrganization -
Organization
|
|
billingEmail -
String
|
The email used for all billing related correspondence. |
slug -
String
|
|
users -
[User]
|
|
organizationUsers -
[OrganizationUser]
|
|
organizationUserInvites -
[OrganizationUserInvite]
|
|
isPersonal -
Boolean
|
|
isInternal -
Boolean
|
|
isSubscribed -
String
|
|
useTestSignatureProvider -
Boolean
|
|
config -
JSON
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
welds -
[Weld]
|
|
etchTemplates -
[EtchTemplate]
|
|
etchPackets -
EtchPacketPage
|
|
weldGroups -
[WeldGroup]
|
|
forges -
[Forge]
|
|
|
Arguments
|
|
forgeMaps -
[ForgeMap]
|
|
casts -
[Cast]
|
|
|
Arguments
|
|
paymentMethods -
[PaymentMethod]
|
|
webhook -
Webhook
|
|
webhookLogs -
WebhookLogPage
|
|
childOrganizations -
[Organization]
|
|
subscribedPlanFeatures -
JSON
|
|
subscriptionActivity -
JSON
|
|
currentInvoice -
Invoice
|
|
totalUsedUnits -
Int
|
|
weldCompleteWebhookStats -
JSON
|
|
weldCompleteStats -
JSON
|
|
etchCompleteStats -
JSON
|
|
remainingSubmissions -
JSON
|
|
remainingEtchCompletions -
JSON
|
|
signatureProviderType -
String
|
|
availableSignatureProviderTypes -
[String]
|
|
Example
{
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "Organization Name",
"logo": {},
"logoURL": "https://domain.com/page.html",
"parentOrganization": Organization,
"billingEmail": "user@domain.com",
"slug": "organization-name",
"users": [User],
"organizationUsers": [OrganizationUser],
"organizationUserInvites": [OrganizationUserInvite],
"isPersonal": true,
"isInternal": true,
"isSubscribed": "xyz789",
"useTestSignatureProvider": false,
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"welds": [Weld],
"etchTemplates": [EtchTemplate],
"etchPackets": EtchPacketPage,
"weldGroups": [WeldGroup],
"forges": [Forge],
"forgeMaps": [ForgeMap],
"casts": [Cast],
"paymentMethods": [PaymentMethod],
"webhook": Webhook,
"webhookLogs": WebhookLogPage,
"childOrganizations": [Organization],
"subscribedPlanFeatures": {},
"subscriptionActivity": {},
"currentInvoice": Invoice,
"totalUsedUnits": 123,
"weldCompleteWebhookStats": {},
"weldCompleteStats": {},
"etchCompleteStats": {},
"remainingSubmissions": {},
"remainingEtchCompletions": {},
"signatureProviderType": "abc123",
"availableSignatureProviderTypes": ["xyz789"]
}
OrganizationPage
| Name | Description |
|---|---|
rowCount -
Int
|
Total number of rows found for the query before pagination |
pageCount -
Int
|
Total number of pages of results |
page -
Int
|
The requested page number |
pageSize -
Int
|
The requested number of rows per page |
items -
[Organization]
|
The actual records for the requested page |
Example
{
"rowCount": 20,
"pageCount": 2,
"page": 1,
"pageSize": 10,
"items": [Organization]
}
OrganizationUser
| Name | Description |
|---|---|
id -
Int!
|
|
role -
String
|
|
user -
User
|
|
organization -
Organization
|
Example
{
"id": 123,
"role": "abc123",
"user": User,
"organization": Organization
}
OrganizationUserInvite
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
role -
String
|
|
name -
String
|
|
email -
String
|
|
organization -
Organization
|
|
acceptedAt -
Date
|
|
revokedAt -
Date
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
Example
{
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"role": "xyz789",
"name": "OrganizationUserInvite Name",
"email": "user@domain.com",
"organization": Organization,
"acceptedAt": "2021-02-24T17:48:58.759Z",
"revokedAt": "2021-02-24T17:48:58.759Z",
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
PaymentMethod
| Name | Description |
|---|---|
id -
String!
|
|
type -
String
|
|
last4 -
String
|
|
providerName -
String
|
|
status -
String
|
|
expMonth -
Int
|
|
expYear -
Int
|
|
isDefault -
Boolean
|
Example
{
"id": "abc123",
"type": "abc123",
"last4": "abc123",
"providerName": "xyz789",
"status": "abc123",
"expMonth": 987,
"expYear": 123,
"isDefault": true
}
Signer
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
status -
String
|
|
provider -
String
|
|
providerConfig -
JSON
|
|
aliasId -
String
|
|
name -
String
|
|
email -
String
|
|
routingOrder -
Int
|
|
documentGroup -
DocumentGroup
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
finishURL -
String
|
|
etchSignURL -
String
|
|
user -
User
|
|
signActionType -
String
|
Example
{
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"status": "xyz789",
"provider": "abc123",
"providerConfig": {},
"aliasId": "xyz789",
"name": "Signer Name",
"email": "user@domain.com",
"routingOrder": 123,
"documentGroup": DocumentGroup,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"finishURL": "https://domain.com/page.html",
"etchSignURL": "https://domain.com/page.html",
"user": User,
"signActionType": "abc123"
}
SignerPage
| Name | Description |
|---|---|
rowCount -
Int
|
Total number of rows found for the query before pagination |
pageCount -
Int
|
Total number of pages of results |
page -
Int
|
The requested page number |
pageSize -
Int
|
The requested number of rows per page |
items -
[Signer]
|
The actual records for the requested page |
Example
{
"rowCount": 20,
"pageCount": 2,
"page": 1,
"pageSize": 10,
"items": [Signer]
}
String
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Submission
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
payload -
JSON
|
|
payloadValue -
JSON
|
|
requestMeta -
JSON
|
|
currentStep -
Int
|
|
totalSteps -
Int
|
|
continueURL -
String
|
|
user -
User
|
|
forge -
Forge
|
|
signer -
Signer
|
|
weldData -
WeldData
|
|
completedAt -
Date
|
|
reviewData -
JSON
|
|
completionPercentage -
Float
|
|
touchedByUser -
Boolean
|
|
isExcluded -
Boolean
|
|
status -
String
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
Example
{
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"payload": {},
"payloadValue": {},
"requestMeta": {},
"currentStep": 123,
"totalSteps": 987,
"continueURL": "https://domain.com/page.html",
"user": User,
"forge": Forge,
"signer": Signer,
"weldData": WeldData,
"completedAt": "2020-08-24T17:48:58.759Z",
"reviewData": {},
"completionPercentage": 33.33,
"touchedByUser": true,
"isExcluded": true,
"status": "abc123",
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
SubmissionPage
| Name | Description |
|---|---|
rowCount -
Int
|
Total number of rows found for the query before pagination |
pageCount -
Int
|
Total number of pages of results |
page -
Int
|
The requested page number |
pageSize -
Int
|
The requested number of rows per page |
items -
[Submission]
|
The actual records for the requested page |
Example
{
"rowCount": 20,
"pageCount": 2,
"page": 1,
"pageSize": 10,
"items": [Submission]
}
User
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
email -
String
|
|
name -
String
|
|
firstName -
String
|
|
lastName -
String
|
|
role -
String
|
What type of role the User has. Either |
verifiedEmail -
Boolean
|
|
preferences -
UserPreferences!
|
|
organizations -
[Organization]
|
|
organizationUsers -
[OrganizationUser]
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
Example
{
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"email": "user@domain.com",
"name": "User Name",
"firstName": "Bobby",
"lastName": "Jones",
"role": "user",
"verifiedEmail": false,
"preferences": UserPreferences,
"organizations": [Organization],
"organizationUsers": [OrganizationUser],
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
UserPage
| Name | Description |
|---|---|
rowCount -
Int
|
Total number of rows found for the query before pagination |
pageCount -
Int
|
Total number of pages of results |
page -
Int
|
The requested page number |
pageSize -
Int
|
The requested number of rows per page |
items -
[User]
|
The actual records for the requested page |
Example
{
"rowCount": 20,
"pageCount": 2,
"page": 1,
"pageSize": 10,
"items": [User]
}
UserUpload
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
location -
String
|
|
user -
User
|
|
etchPacket -
EtchPacket
|
|
weldData -
WeldData
|
|
forge -
Forge
|
|
metadata -
JSON
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
Example
{
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"location": "abc123",
"user": User,
"etchPacket": EtchPacket,
"weldData": WeldData,
"forge": Forge,
"metadata": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
Webhook
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
status -
String
|
|
type -
String
|
|
url -
String
|
|
token -
String
|
|
creationUser -
User
|
|
organization -
Organization
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
millisecondsToFinish -
Int
|
|
statusCode -
Int
|
Example
{
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"status": "abc123",
"type": "xyz789",
"url": "https://domain.com/page.html",
"token": "abc123",
"creationUser": User,
"organization": Organization,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"millisecondsToFinish": 123,
"statusCode": 987
}
WebhookLog
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
organization -
Organization
|
|
action -
String
|
|
isError -
Boolean
|
|
isRetry -
Boolean
|
|
statusCode -
Int
|
|
millisecondsToFinish -
Int
|
|
objectEid -
String
|
|
rootObjectType -
String
|
|
rootObjectURL -
String
|
|
objectMetadata -
JSON
|
|
originalWebhookLog -
WebhookLog
|
|
createdAt -
Date
|
Example
{
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"organization": Organization,
"action": "abc123",
"isError": false,
"isRetry": true,
"statusCode": 123,
"millisecondsToFinish": 987,
"objectEid": "kQp2qd9FVUWrrE60hMbi",
"rootObjectType": "abc123",
"rootObjectURL": "https://domain.com/page.html",
"objectMetadata": {},
"originalWebhookLog": WebhookLog,
"createdAt": "2021-02-24T17:48:58.996Z"
}
WebhookLogPage
| Name | Description |
|---|---|
rowCount -
Int
|
Total number of rows found for the query before pagination |
pageCount -
Int
|
Total number of pages of results |
page -
Int
|
The requested page number |
pageSize -
Int
|
The requested number of rows per page |
items -
[WebhookLog]
|
The actual records for the requested page |
Example
{
"rowCount": 20,
"pageCount": 2,
"page": 1,
"pageSize": 10,
"items": [WebhookLog]
}
Weld
A Weld is the configuration that combines one or more {Forge} objects with zero or more {Cast} objects to create a workflow.
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
slug -
String
|
|
name -
String
|
|
title -
String
|
|
visibility -
String
|
|
config -
JSON
|
Config object specifying files output, signers, etc. |
|
Arguments
Only root level keys specified here will be returned. When omitted, all keys will be returned. |
|
organization -
Organization
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
isTest -
Boolean
|
|
hasSigners -
Boolean
|
|
forges -
[Forge]
|
|
|
Arguments
|
|
casts -
[Cast]
|
|
versions -
[WeldVersion]
|
|
weldGroups -
[WeldGroup]
|
|
weldDatas -
WeldDataPage
|
|
hasWeldDatas -
Boolean
|
|
weldDataCounts -
JSON
|
|
archivedAt -
Date
|
|
expiresAt -
Date
|
|
draftStep -
String
|
|
signatureProviderType -
String
|
|
availableSignatureProviderTypes -
[String]
|
|
remainingSubmissions -
JSON
|
|
Example
{
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"slug": "weld-name",
"name": "Weld Name",
"title": "Weld Title",
"visibility": "abc123",
"config": {},
"organization": Organization,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"isTest": false,
"hasSigners": true,
"forges": [Forge],
"casts": [Cast],
"versions": [WeldVersion],
"weldGroups": [WeldGroup],
"weldDatas": WeldDataPage,
"hasWeldDatas": true,
"weldDataCounts": {},
"archivedAt": "2020-08-24T17:48:58.759Z",
"expiresAt": "2021-02-24T17:48:58.759Z",
"draftStep": "abc123",
"signatureProviderType": "abc123",
"availableSignatureProviderTypes": ["xyz789"],
"remainingSubmissions": {}
}
WeldData
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
weld -
Weld
|
|
weldDataGroup -
WeldDataGroup
|
|
submissions -
[Submission]
|
|
isComplete -
Boolean
|
|
isExpired -
Boolean
|
|
isCompleteAndSigned -
Boolean
|
|
isTest -
Boolean
|
|
hasSigners -
Boolean
|
|
forgesRequiringCompletion -
[Forge]
|
|
displayTitle -
String
|
|
dataUpdatedAt -
Date
|
|
documentGroup -
DocumentGroup
|
|
continueURL -
String
|
|
webhookURL -
String
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
expiresAt -
Date
|
|
status -
String
|
|
payloadCanBeUpdated -
Boolean
|
|
completionPercentage -
String
|
|
numberRemainingSigners -
Int
|
|
nextSigner -
Signer
|
|
archivedAt -
Date
|
|
files -
[JSON]
|
|
excludedFiles -
[JSON]
|
|
agents -
JSON
|
|
pin -
String
|
|
webhookLogs -
[WebhookLog]
|
|
etchLogEvents -
[EtchLog]
|
|
weldDataLogEvents -
[WeldDataLog]
|
|
userUploads -
[UserUpload]
|
Example
{
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"weld": Weld,
"weldDataGroup": WeldDataGroup,
"submissions": [Submission],
"isComplete": false,
"isExpired": false,
"isCompleteAndSigned": false,
"isTest": true,
"hasSigners": false,
"forgesRequiringCompletion": [Forge],
"displayTitle": "abc123",
"dataUpdatedAt": "2020-08-24T17:48:58.759Z",
"documentGroup": DocumentGroup,
"continueURL": "https://domain.com/page.html",
"webhookURL": "https://domain.com/page.html",
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"expiresAt": "2020-08-24T17:48:58.759Z",
"status": "abc123",
"payloadCanBeUpdated": false,
"completionPercentage": "abc123",
"numberRemainingSigners": 987,
"nextSigner": Signer,
"archivedAt": "2021-02-24T17:48:58.759Z",
"files": [{}],
"excludedFiles": [{}],
"agents": {},
"pin": "9876",
"webhookLogs": [WebhookLog],
"etchLogEvents": [EtchLog],
"weldDataLogEvents": [WeldDataLog],
"userUploads": [UserUpload]
}
WeldDataGroup
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
title -
String
|
|
isTest -
Boolean
|
|
dataUpdatedAt -
Date
|
|
weldGroup -
WeldGroup
|
|
weldDatas -
[WeldData]
|
|
|
Arguments
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
archivedAt -
Date
|
|
Example
{
"id": 987,
"eid": "kQp2qd9FVUWrrE60hMbi",
"title": "WeldDataGroup Title",
"isTest": true,
"dataUpdatedAt": "2021-02-24T17:48:58.759Z",
"weldGroup": WeldGroup,
"weldDatas": [WeldData],
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"archivedAt": "2021-02-24T17:48:58.759Z"
}
WeldDataGroupPage
| Name | Description |
|---|---|
rowCount -
Int
|
Total number of rows found for the query before pagination |
pageCount -
Int
|
Total number of pages of results |
page -
Int
|
The requested page number |
pageSize -
Int
|
The requested number of rows per page |
items -
[WeldDataGroup]
|
The actual records for the requested page |
Example
{
"rowCount": 20,
"pageCount": 2,
"page": 1,
"pageSize": 10,
"items": [WeldDataGroup]
}
WeldDataLog
| Name | Description |
|---|---|
id -
Int!
|
|
action -
String
|
|
user -
User
|
|
formattedLocation -
String
|
|
weldData -
WeldData
|
|
submission -
Submission
|
|
createdAt -
Date
|
|
metadata -
JSON
|
Example
{
"id": 123,
"action": "xyz789",
"user": User,
"formattedLocation": "xyz789",
"weldData": WeldData,
"submission": Submission,
"createdAt": "2021-02-24T17:48:58.996Z",
"metadata": {}
}
WeldDataPage
| Name | Description |
|---|---|
rowCount -
Int
|
Total number of rows found for the query before pagination |
pageCount -
Int
|
Total number of pages of results |
page -
Int
|
The requested page number |
pageSize -
Int
|
The requested number of rows per page |
items -
[WeldData]
|
The actual records for the requested page |
Example
{
"rowCount": 20,
"pageCount": 2,
"page": 1,
"pageSize": 10,
"items": [WeldData]
}
WeldGroup
| Name | Description |
|---|---|
id -
Int!
|
|
eid -
String
|
|
name -
String
|
|
slug -
String
|
|
organization -
Organization
|
|
welds -
[Weld]
|
|
|
Arguments
|
|
weldDataGroups -
WeldDataGroupPage
|
|
hasWeldDataGroups -
Boolean
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
Example
{
"id": 123,
"eid": "kQp2qd9FVUWrrE60hMbi",
"name": "WeldGroup Name",
"slug": "weldgroup-name",
"organization": Organization,
"welds": [Weld],
"weldDataGroups": WeldDataGroupPage,
"hasWeldDataGroups": true,
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z"
}
WeldPage
| Name | Description |
|---|---|
rowCount -
Int
|
Total number of rows found for the query before pagination |
pageCount -
Int
|
Total number of pages of results |
page -
Int
|
The requested page number |
pageSize -
Int
|
The requested number of rows per page |
items -
[Weld]
|
The actual records for the requested page |
Example
{
"rowCount": 20,
"pageCount": 2,
"page": 1,
"pageSize": 10,
"items": [Weld]
}
WeldVersion
| Name | Description |
|---|---|
id -
Int!
|
|
updatedColumns -
[String]
|
|
name -
String
|
|
slug -
String
|
|
config -
JSON
|
|
createdAt -
Date
|
|
updatedAt -
Date
|
|
user -
User
|
Example
{
"id": 123,
"updatedColumns": ["xyz789"],
"name": "WeldVersion Name",
"slug": "weldversion-name",
"config": {},
"createdAt": "2021-02-24T17:48:58.996Z",
"updatedAt": "2021-02-24T17:48:58.996Z",
"user": User
}
