object WorkflowsGetAsyncJobStatus404Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "NOT_FOUND"
    },
    "param": {
      "type": "string",
      "example": "parameter identifier"
    },
    "message": {
      "type": "string",
      "example": "not found"
    }
  }
}

object WorkflowsGetAsyncJobStatusResponse

{
  "type": "object",
  "oneOf": [
    {
      "$ref": "#/components/schemas/WorkflowAsyncLaunchSuccessResponse"
    },
    {
      "$ref": "#/components/schemas/WorkflowAsyncLaunchFailedResponse"
    },
    {
      "$ref": "#/components/schemas/WorkflowAsyncInProgressResponse"
    }
  ],
  "title": "Workflow Launch Status",
  "readOnly": true,
  "description": "The current status of the launch workflow job."
}

object WorkflowsGetAttachmentFromEmailThread404Response

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/WorkflowNotFound"
    },
    {
      "$ref": "#/components/schemas/EmailNotFound"
    },
    {
      "$ref": "#/components/schemas/AttachmentNotFound"
    }
  ]
}

object WorkflowsGetAttachmentFromEmailThreadResponse

{
  "type": "object",
  "properties": {}
}

object WorkflowsGetDocumentByKey400Response

{
  "type": "object",
  "properties": {}
}

object WorkflowsGetDocumentByKeyResponse

{
  "type": "object",
  "properties": {}
}

object WorkflowsGetEmailThreadResponse

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/WorkflowNotFound"
    },
    {
      "$ref": "#/components/schemas/EmailNotFound"
    }
  ]
}

object WorkflowsGetEmailThreadsResponse

{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmailResponseModel"
      }
    },
    "page": {
      "type": "integer",
      "default": 0,
      "example": 0
    },
    "count": {
      "type": "integer",
      "example": 1
    },
    "pageSize": {
      "type": "integer",
      "default": 20,
      "example": 20
    }
  }
}

object WorkflowsGetTurnHistory403Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "FORBIDDEN"
    },
    "message": {
      "type": "string",
      "example": "access forbidden"
    }
  }
}

object WorkflowsGetTurnHistory404Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "NOT_FOUND"
    },
    "param": {
      "type": "string",
      "example": "workflowId"
    },
    "message": {
      "type": "string",
      "example": "workflow does not exist"
    }
  }
}

object WorkflowsGetTurnHistoryResponse

{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "turnParty": {
            "type": "string",
            "example": "internal"
          },
          "turnNumber": {
            "type": "integer",
            "example": 1
          },
          "turnUserId": {
            "type": "string",
            "example": "5f89b6a5eed2cc6e0b2735d4"
          },
          "turnEndTime": {
            "type": "string",
            "example": "2022-09-28T19:21:05.034Z"
          },
          "turnLocation": {
            "type": "string",
            "example": "manual change"
          },
          "turnStartTime": {
            "type": "string",
            "example": "2022-09-20T15:51:54.156Z"
          },
          "turnUserEmail": {
            "type": "string",
            "example": "baldwin@ironcladhq.com"
          }
        }
      }
    },
    "page": {
      "type": "integer",
      "default": 0,
      "example": 0
    },
    "count": {
      "type": "integer",
      "example": 42
    },
    "pageSize": {
      "type": "integer",
      "default": 20,
      "example": 20
    }
  }
}

object WorkflowsGetWorkflowResponse

{
  "type": "object",
  "properties": {}
}

object WorkflowsGetWorkflowSchema400Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "param": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

object WorkflowsGetWorkflowSchemaResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "6013609108b8f070cee94fc1"
    },
    "name": {
      "type": "string",
      "example": "MNDA"
    },
    "schema": {
      "type": "object",
      "properties": {
        "fee": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "monetaryAmount"
            },
            "displayName": {
              "type": "string",
              "example": "Example Monetary Amount Attribute"
            }
          }
        },
        "draft": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "array"
            },
            "elementType": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "example": "document"
                },
                "displayName": {
                  "type": "string",
                  "example": "Example Document Attribute"
                }
              }
            }
          }
        },
        "amount": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "number"
            },
            "displayName": {
              "type": "string",
              "example": "Example Number Attribute"
            }
          }
        },
        "lineItems": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "array"
            },
            "elementType": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "example": "object"
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "childAttribute": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string",
                          "example": "string"
                        },
                        "displayName": {
                          "type": "string",
                          "example": "Example String Attribute"
                        }
                      }
                    },
                    "anotherChildAttribute": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string",
                          "example": "string"
                        },
                        "displayName": {
                          "type": "string",
                          "example": "Example String Attribute"
                        }
                      }
                    }
                  }
                },
                "displayName": {
                  "type": "string",
                  "example": "Example Object Attribute"
                }
              }
            }
          }
        },
        "counterpartyName": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "string"
            },
            "displayName": {
              "type": "string",
              "example": "Example String Attribute"
            }
          }
        }
      }
    },
    "permissions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "launch",
        "view"
      ]
    }
  }
}

object WorkflowsLaunchAsynchronously400Response

{
  "type": "object",
  "properties": {}
}

object WorkflowsLaunchAsynchronouslyResponse

{
  "type": "object",
  "title": "",
  "required": [
    "asyncJobId",
    "asyncJobStatusUrl"
  ],
  "properties": {
    "asyncJobId": {
      "type": "string",
      "title": "",
      "example": "jobIda89474a8ba364f79bb510517d7bd3fea",
      "readOnly": true,
      "description": ""
    },
    "asyncJobStatusUrl": {
      "type": "string",
      "title": "",
      "example": "http://ironcladapp.com/public/api/v1/workflows/async/jobIda89474a8ba364f79bb510517d7bd3fea",
      "readOnly": true,
      "description": ""
    }
  },
  "description": ""
}

object WorkflowsListAllParticipants403Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "FORBIDDEN"
    },
    "message": {
      "type": "string",
      "example": "access forbidden"
    }
  }
}

object WorkflowsListAllParticipants404Response

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/WorkflowNotFound"
    }
  ]
}

object WorkflowsListAllParticipantsResponse

{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "example": "boba@intergalactic.com"
          },
          "userId": {
            "type": "string",
            "example": "61968ae4945dcecf4a78cc83"
          }
        }
      }
    },
    "page": {
      "type": "integer",
      "default": 0,
      "example": 0
    },
    "count": {
      "type": "integer",
      "example": 1
    },
    "pageSize": {
      "type": "integer",
      "default": 20,
      "example": 20
    }
  }
}

object WorkflowsListAllResponse

{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WorkflowResponseModel"
      }
    },
    "page": {
      "type": "integer",
      "default": 0,
      "example": 0
    },
    "count": {
      "type": "integer",
      "default": 0,
      "example": 1234
    },
    "pageSize": {
      "type": "integer",
      "default": 0,
      "example": 20
    }
  }
}

object WorkflowsListAllWorkflowSchemas400Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "MISSING_PARAM"
    },
    "param": {
      "type": "string",
      "example": "parameter identifier"
    },
    "message": {
      "type": "string",
      "example": "reason why something has gone wrong"
    }
  }
}

object WorkflowsListAllWorkflowSchemasResponse

{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "a1b2c3d4"
          },
          "name": {
            "type": "string",
            "example": "MNDA"
          },
          "schema": {
            "type": "object",
            "properties": {
              "fee": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "example": "monetaryAmount"
                  },
                  "displayName": {
                    "type": "string",
                    "example": "Example Monetary Amount Attribute"
                  }
                }
              },
              "draft": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "example": "array"
                  },
                  "elementType": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "example": "document"
                      },
                      "displayName": {
                        "type": "string",
                        "example": "Example Document Attribute"
                      }
                    }
                  }
                }
              },
              "amount": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "example": "number"
                  },
                  "displayName": {
                    "type": "string",
                    "example": "Example Number Attribute"
                  }
                }
              },
              "lineItems": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "example": "array"
                  },
                  "elementType": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "example": "object"
                      },
                      "schema": {
                        "type": "object",
                        "properties": {
                          "childAttribute": {
                            "type": "object",
                            "properties": {
                              "type": {
                                "type": "string",
                                "example": "string"
                              },
                              "displayName": {
                                "type": "string",
                                "example": "Example String Attribute"
                              }
                            }
                          },
                          "anotherChildAttribute": {
                            "type": "object",
                            "properties": {
                              "type": {
                                "type": "string",
                                "example": "string"
                              },
                              "displayName": {
                                "type": "string",
                                "example": "Example String Attribute"
                              }
                            }
                          }
                        }
                      },
                      "displayName": {
                        "type": "string",
                        "example": "Example Object Attribute"
                      }
                    }
                  }
                }
              },
              "counterpartyName": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "example": "string"
                  },
                  "displayName": {
                    "type": "string",
                    "example": "Example String Attribute"
                  }
                }
              }
            }
          },
          "permissions": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "launch",
              "view"
            ]
          }
        }
      }
    }
  }
}

object WorkflowsListApprovals400Response

{
  "type": "object",
  "properties": {}
}

object WorkflowsListApprovalsResponse

{
  "type": "object",
  "properties": {
    "roles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "legal"
          },
          "assignees": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "email": {
                  "type": "string",
                  "example": "bobafett@gmail.com"
                },
                "userId": {
                  "type": "string",
                  "example": "63d415e0dd0d828c3a878548"
                },
                "userName": {
                  "type": "string",
                  "example": "Boba Fett"
                }
              }
            }
          },
          "displayName": {
            "type": "string",
            "example": "Legal"
          }
        }
      }
    },
    "title": {
      "type": "string",
      "example": "Consulting Agreement with Michael Scott Paper Company"
    },
    "workflowId": {
      "type": "string",
      "example": "5f595f76c4fc9b3571413c3ac"
    },
    "approvalGroups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "reviewers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "role": {
                  "type": "string",
                  "example": "finance"
                },
                "status": {
                  "type": "string",
                  "example": "pending"
                },
                "displayName": {
                  "type": "string",
                  "example": "Finance"
                },
                "reviewerType": {
                  "type": "string",
                  "example": "role"
                }
              }
            }
          }
        }
      }
    }
  }
}

object WorkflowsListSignatures400Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "INVALID_STATE"
    },
    "message": {
      "type": "string",
      "example": "This workflow is not at the Sign step, and is currently at the Review step"
    }
  }
}

object WorkflowsListSignatures403Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "FORBIDDEN"
    },
    "message": {
      "type": "string",
      "example": "access forbidden"
    }
  }
}

object WorkflowsListSignaturesResponse

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "example": "Goldendoodle Adoption Contract"
    },
    "signers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jimothy Kim"
          },
          "email": {
            "type": "string",
            "example": "jimothykim@gmail.com"
          },
          "roleName": {
            "type": "string",
            "example": "Counterparty Signer"
          },
          "delegates": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "example": "Kim Lam"
                },
                "email": {
                  "type": "string",
                  "example": "kimlam@gmail.com"
                }
              }
            }
          },
          "signatureStatus": {
            "type": "string",
            "example": "sent"
          }
        }
      }
    },
    "workflowId": {
      "type": "string",
      "example": "6dac47a10b1242d1f7df688d"
    }
  }
}

object WorkflowsRevertToReview403Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "FORBIDDEN"
    },
    "param": {
      "type": "string",
      "example": "user"
    },
    "message": {
      "type": "string",
      "example": "user is not a participant on the workflow"
    }
  }
}

object WorkflowsRevertToReview404Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "NOT_FOUND"
    },
    "param": {
      "type": "string",
      "example": "workflowId"
    },
    "message": {
      "type": "string",
      "example": "workflow does not exist"
    }
  }
}

object WorkflowsRevertToReviewRequest

{
  "type": "object",
  "required": [
    "user",
    "status"
  ],
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "default": "email",
          "description": "The mechanism of identifying the Ironclad user's account."
        },
        "email": {
          "type": "string",
          "example": "jango@intergalactic.com",
          "description": "The Ironclad user's email address."
        }
      },
      "description": "The Ironclad user reverting the workflow to the Review step. The user must be a participant on the workflow."
    }
  }
}

object WorkflowsRevertToReviewResponse

{
  "type": "object",
  "properties": {
    "code": {
      "enum": [
        "INVALID_PARAM",
        "INVALID_STATE"
      ],
      "type": "string",
      "example": "INVALID_STATE"
    },
    "param": {
      "type": "string",
      "example": "user"
    },
    "message": {
      "enum": [
        "invalid user for user attribute",
        "workflow was not built in workflow designer and cannot be reverted to review via the API",
        "workflow cannot be reverted to review as it is not in the sign stage",
        "various malformed user payload messages"
      ],
      "type": "string",
      "example": "workflow cannot be reverted to review as it is not in the sign stage"
    }
  }
}

object WorkflowsUpdateApprovalStatus400Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "INVALID_PARAM"
    },
    "param": {
      "type": "string",
      "example": "approval"
    },
    "message": {
      "enum": [
        "This role does not exist in this workflow",
        "invalid user for user attribute",
        "This approval either was not requested or this user was not assigned to this approval"
      ],
      "type": "string",
      "example": "This role does not exist in this workflow"
    }
  }
}

object WorkflowsUpdateApprovalStatusRequest

{
  "type": "object",
  "required": [
    "user",
    "status"
  ],
  "properties": {
    "user": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "default": "email",
          "description": "The mechanism of identifying the Ironclad user's account."
        },
        "email": {
          "type": "string",
          "example": "fett@intergalactic.com",
          "description": "The Ironclad user's email address."
        }
      },
      "description": "The Ironclad user approving the workflow. The user must be currently assigned as the approver."
    },
    "status": {
      "enum": [
        "approved",
        "pending"
      ],
      "type": "string",
      "description": "The new approval status."
    }
  }
}

boolean WorkflowsUpdateApprovalStatusResponse

{
  "type": "boolean",
  "example": true
}

object WorkflowsUpdateMetadata400Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "param": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

object WorkflowsUpdateMetadata403Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "FORBIDDEN"
    },
    "message": {
      "type": "string",
      "example": "access forbidden"
    }
  }
}

object WorkflowsUpdateMetadata404Response

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "NOT_FOUND"
    },
    "param": {
      "type": "string",
      "example": "parameter identifier"
    },
    "message": {
      "type": "string",
      "example": "not found"
    }
  }
}

object WorkflowsUpdateMetadataRequest

{
  "type": "object",
  "required": [
    "updates"
  ],
  "properties": {
    "comment": {
      "type": "string",
      "example": "Changing attribute on a Workflow.",
      "description": "A comment that explains the updates you are making to the workflow."
    },
    "updates": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "action",
          "path"
        ],
        "properties": {
          "path": {
            "type": "string",
            "example": "counterpartyName",
            "description": "The workflow attribute id that you'd like to make a change to. Workflow attribute IDs and values can be retrieved using the [Retrieve a Workflow](https://developer.ironcladapp.com/reference/retrieve-a-workflow) endpoint."
          },
          "value": {
            "type": "string",
            "example": "Example Company",
            "description": "The value to change the attribute to. Only required when the `action` property is `set` and not `remove`. The value's format must conform to the field type (e.g., `\"someString\"` for strings, `true` or `false` for booleans, etc."
          },
          "action": {
            "enum": [
              "set",
              "remove"
            ],
            "type": "string",
            "default": "set",
            "description": "The type of action you'd like to take on an existing attribute (read-only fields cannot be updated). Use the remove action to clear values. If using the remove action, the attribute cannot be required by the workflow."
          }
        }
      }
    }
  }
}

object WorkflowsUpdateMetadataResponse

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "6013609108b8f070cee94fc1"
    },
    "step": {
      "type": "string",
      "example": "Review"
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "legal"
          },
          "assignees": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "email": {
                  "type": "string",
                  "example": "bobafett@gmail.com"
                },
                "userId": {
                  "type": "string",
                  "example": "63d415e0dd0d828c3a878548"
                },
                "userName": {
                  "type": "string",
                  "example": "Boba Fett"
                }
              }
            }
          },
          "displayName": {
            "type": "string",
            "example": "Legal"
          }
        }
      }
    },
    "title": {
      "type": "string",
      "example": "Consulting Agreement with Jane Doe"
    },
    "schema": {
      "type": "object",
      "properties": {
        "fee": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "monetaryAmount"
            },
            "displayName": {
              "type": "string",
              "example": "Example Monetary Amount Attribute"
            }
          }
        },
        "draft": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "array"
            },
            "elementType": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "example": "document"
                },
                "displayName": {
                  "type": "string",
                  "example": "Example Document Attribute"
                }
              }
            }
          }
        },
        "amount": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "number"
            },
            "displayName": {
              "type": "string",
              "example": "Example Number Attribute"
            }
          }
        },
        "lineItems": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "array"
            },
            "elementType": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "example": "object"
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "childAttribute": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string",
                          "example": "string"
                        },
                        "displayName": {
                          "type": "string",
                          "example": "Example String Attribute"
                        }
                      }
                    },
                    "anotherChildAttribute": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string",
                          "example": "string"
                        },
                        "displayName": {
                          "type": "string",
                          "example": "Example String Attribute"
                        }
                      }
                    }
                  }
                },
                "displayName": {
                  "type": "string",
                  "example": "Example Object Attribute"
                }
              }
            }
          }
        },
        "counterpartyName": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "string"
            },
            "displayName": {
              "type": "string",
              "example": "Example String Attribute"
            }
          }
        }
      }
    },
    "status": {
      "type": "string",
      "example": "active"
    },
    "created": {
      "type": "string",
      "example": "2016-11-17T00:37:22.318Z"
    },
    "creator": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "63d415e0dd0d828c3a878548"
        },
        "email": {
          "type": "string",
          "example": "fett@intergalactic.com"
        },
        "displayName": {
          "type": "string",
          "example": "Boba Fett"
        }
      }
    },
    "template": {
      "type": "string",
      "example": "600b296c3e15a234ab88f884"
    },
    "approvals": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "example": "https://ironcladapp.com/public/api/v1/workflows/22e2ff72-56a1-4711-a4ca-41328d311e9f/approvals"
        },
        "state": {
          "type": "string",
          "example": "in_progess"
        }
      }
    },
    "recordIds": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "715f1e37-292f-4e6c-8b48-c07e1b68bccd"
      }
    },
    "attributes": {
      "type": "object",
      "properties": {
        "fee": {
          "type": "object",
          "properties": {
            "amount": {
              "type": "integer",
              "default": 0,
              "example": 50000
            },
            "currency": {
              "type": "string",
              "example": "USD"
            }
          }
        },
        "draft": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "version": {
                "type": "string",
                "example": "B1QePArXb"
              },
              "download": {
                "type": "string",
                "example": "/public/api/v1/workflows/594356b9fbcd7f74006fdf8a/document/rJklwCHQ/download"
              },
              "filename": {
                "type": "string",
                "example": "file.pdf"
              }
            }
          }
        },
        "amount": {
          "type": "integer",
          "default": 0,
          "example": 123
        },
        "counterpartyName": {
          "type": "string",
          "example": "Boba Fett"
        }
      }
    },
    "ironcladId": {
      "type": "string",
      "example": "IC-1"
    },
    "isComplete": {
      "type": "boolean",
      "default": true,
      "example": false
    },
    "signatures": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "example": "https://ironcladapp.com/public/api/v1/workflows/6dac47a10b1242d1f7df688d/signatures"
        },
        "state": {
          "type": "string",
          "example": "in_progess"
        }
      }
    },
    "isCancelled": {
      "type": "boolean",
      "default": true,
      "example": false
    },
    "lastUpdated": {
      "type": "string",
      "example": "2016-11-17T00:37:22.318Z"
    },
    "isRevertibleToReview": {
      "type": "boolean",
      "example": false
    }
  }
}

string webhookEventTypeValue

{
  "enum": [
    "*",
    "workflow_launched",
    "workflow_updated",
    "workflow_cancelled",
    "workflow_completed",
    "workflow_approval_status_changed",
    "workflow_attribute_updated",
    "workflow_comment_added",
    "workflow_comment_removed",
    "workflow_comment_updated",
    "workflow_comment_reaction_added",
    "workflow_comment_reaction_removed",
    "workflow_counterparty_invite_sent",
    "workflow_counterparty_invite_revoked",
    "workflow_documents_added",
    "workflow_documents_removed",
    "workflow_documents_updated",
    "workflow_documents_renamed",
    "workflow_document_edited",
    "workflow_changed_turn",
    "workflow_paused",
    "workflow_resumed",
    "workflow_signature_packet_sent",
    "workflow_signature_packet_uploaded",
    "workflow_signature_packet_cancelled",
    "workflow_signer_added",
    "workflow_signer_removed",
    "workflow_signer_reassigned",
    "workflow_step_updated"
  ],
  "type": "string",
  "example": "workflow_launched"
}

object webhookInvalidEventTypeBadRequestResponse

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "INVALID_PARAM"
    },
    "param": {
      "type": "string",
      "example": "events"
    },
    "message": {
      "type": "string",
      "example": "invalid event type; *, workflow_launched, workflow_updated, workflow_cancelled, workflow_completed, workflow_approval_status_changed, workflow_attribute_updated, workflow_changed_turn, workflow_comment_reaction_added, workflow_comment_reaction_removed, workflow_comment_added, workflow_comment_removed, workflow_comment_updated, workflow_counterparty_invite_sent, workflow_counterparty_invite_revoked, workflow_documents_added, workflow_documents_removed, workflow_documents_updated, workflow_documents_renamed, workflow_document_edited, workflow_paused, workflow_resumed, workflow_signature_packet_sent, workflow_signature_packet_uploaded, or workflow_signature_packet_cancelled, workflow_signer_added, workflow_signer_removed, workflow_signer_reassigned are acceptable event types"
    }
  }
}

object webhookTargetURLExistsBadRequestResponse

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "INVALID_PARAM"
    },
    "param": {
      "type": "string",
      "example": "tagetURL"
    },
    "message": {
      "type": "string",
      "example": "webhook already exists for event workflow_completed and target [SOME_EXISTING_TARGET_URL]"
    }
  }
}