/server_stamps

POST {{base-api-url}}/server_stamps

Request Body

{"file"=>"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "config"=>{"webhook"=>{"server_stamp.finished"=>[{"url"=>"https://YOUR_WEBHOOK_URL.com", "method"=>"GET", "headers"=>{"X-test-header"=>"Sample - dev for server stamp"}}], "server_stamp.error"=>[{"url"=>"https://YOUR_WEBHOOK_URL_WHEN_ERROR_OCCURRED.com", "method"=>"GET", "headers"=>{"X-test-header"=>"Sample - dev for server stamp"}}]}}, "fileObjects"=>[{"page"=>2, "position"=>"400,700,500,800", "mention"=>"Sample - Mention (top)", "mention2"=>"Sample - Mention (bottom)"}], "signImage"=>"iVBORw0KGgoAAAANSUhEUgAA [...] 6T0fAAAAABJRU5ErkJggg=="}

HEADERS

KeyDatatypeRequiredDescription
AuthorizationstringThis value is a secret and needs to be replaced by your API Key (Bearer).
Content-TypestringThis header specifies the format of the exchanges in JSON.

RESPONSES

status: Created

{"id":"/server_stamps/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","file":"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","certificate":"/certificates/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","fileObjects":[{"id":"/file_objects/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","page":2,"position":"400,700,500,800","fieldName":null,"mention":"Sample - Mention (top)","mention2":"Sample - Mention (bottom)","createdAt":"2018-12-07T08:32:59+01:00","updatedAt":"2018-12-07T08:32:59+01:00"}],"config":{"webhook":{"server_stamp.finished":[{"url":"https://YOUR_WEBHOOK_URL.com","method":"GET","headers":{"X-test-header":"Sample - dev for server stamp"}}],"server_stamp.error":[{"url":"https://YOUR_WEBHOOK_URL_WHEN_ERROR_OCCURRED.com","method":"GET","headers":{"X-test-header":"Sample - dev for server stamp"}}]}},"createdAt":"2018-12-07T08:32:59+01:00","updatedAt":"2018-12-07T08:32:59+01:00","finishedAt":null,"status":"pending","workspace":"/workspaces/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}