Form: Webhooks

Event

form_submitted_v2

1{
2  "accountId": "",
3  "submittedFormId": "",
4  "submittedAt": "<YYYY-MM-ddThh:mm:ss.SSSZ>",
5  "formLibraryDetail": {
6    "formLibraryId": "",
7    "type": "",
8    "partnerMetadata": ""
9  },
10  "assignment": {
11    "submissionId": "",
12    "partnerMetadata": "",
13    "index": 1
14  },
15  "title": ""
16}

Description

Push notification event to partner when a form was submitted.

Payload Summary

• accountId: (non-null string) the unique identifier of the account

• submittedFormId: (non-null string) the unique identifier for the form being submitted

• submittedAt: (non-null string) the date/time the form was submitted in ISO-8601

• formLibraryDetail: (nullable object)

  • formLibraryId: (non-null string) the unique identifier of the library form matches with Public API /form/RetrieveFormList response of formLibraryDetails[i].formLibraryId

  • type: (non-null string) either VENDOR or ACCOUNT of the library form

  • partnerMetadata: (nullable string) the metadata, if specified, for a VENDOR type library form

• assignment: (nullable object)

  • submissionId (non-null string) the unique identifier of the assignment submission matches with Public API /form/SendFormAssignment response of assignmentSubmissionId

  • partnerMetadata: (nullable string) the metadata, if specified, which was sent in Public API /form/SendFormAssignment request

  • index: (non-null number) the index of the formLibraryId as specified in Public API /form/SendFormAssignment request’s assgnedForms

• title: (non-null string) the title of the form being submitted

Changes v1 → v2 (e.g. form_submitted to form_submitted_v2)

• Renamed formId to submittedFormId

• Renamed timestamp to submittedAt

• Added formLibraryDetail

• Added assignment

• Drops unused conformsTo