POST reapitforms/v1/events/documents/statusupdate
Request Information
URI Parameters
None.
Body Parameters
DocumentStatusChangeWebhookPayload| Name | Description | Type | Additional information |
|---|---|---|---|
| ReferenceID | globally unique identifier |
None. |
|
| OrganizationID | globally unique identifier |
None. |
|
| PreviousStatus | integer |
None. |
|
| CurrentStatus | DocumentStatus |
None. |
|
| LastAction | DocumentActivity |
None. |
|
| ValidFromUTC | date |
None. |
|
| DocumentType | DocumentType |
None. |
|
| PdfAvailable | boolean |
None. |
|
| RedactedPdfAvailable | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"ReferenceID": "ccee1c33-f66a-4f37-acc6-dcff63f66a61",
"OrganizationID": "93e2cf5d-a88c-40e8-9e0a-df0a0146c763",
"PreviousStatus": 3,
"CurrentStatus": 0,
"LastAction": 0,
"ValidFromUTC": "2026-10-03T09:41:03.6821129+00:00",
"DocumentType": 0,
"PdfAvailable": true,
"RedactedPdfAvailable": true
}
application/xml, text/xml
Sample:
<DocumentStatusChangeWebhookPayload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.Business.Integration.ReapitForms.Jobs"> <CurrentStatus>None</CurrentStatus> <DocumentType>Standard</DocumentType> <LastAction>None</LastAction> <OrganisationID>93e2cf5d-a88c-40e8-9e0a-df0a0146c763</OrganisationID> <PdfAvailable>true</PdfAvailable> <PreviousStatus>3</PreviousStatus> <RedactedPdfAvailable>true</RedactedPdfAvailable> <ReferenceID>ccee1c33-f66a-4f37-acc6-dcff63f66a61</ReferenceID> <ValidFromUTC>2026-10-03T09:41:03.6821129+00:00</ValidFromUTC> </DocumentStatusChangeWebhookPayload>
multipart/form-data
Sample:
<DocumentStatusChangeWebhookPayload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.Business.Integration.ReapitForms.Jobs"><CurrentStatus>None</CurrentStatus><DocumentType>Standard</DocumentType><LastAction>None</LastAction><OrganisationID>93e2cf5d-a88c-40e8-9e0a-df0a0146c763</OrganisationID><PdfAvailable>true</PdfAvailable><PreviousStatus>3</PreviousStatus><RedactedPdfAvailable>true</RedactedPdfAvailable><ReferenceID>ccee1c33-f66a-4f37-acc6-dcff63f66a61</ReferenceID><ValidFromUTC>2026-10-03T09:41:03.6821129+00:00</ValidFromUTC></DocumentStatusChangeWebhookPayload>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |