{"info":{"contact":{"email":"api@biglelegal.com"},"description":"API Webhooks","license":{"name":"","url":""},"termsOfService":"https://www.biglelegal.com/en/terms-and-conditions","title":"Bigle API Webhooks","version":"v1.0.21"},"openapi":"3.0.1","paths":{"/status":{"get":{"description":"This endpoint returns the API status. You either get a successful response if the API is active or an error otherway.","summary":"Get endpoint status.","operationId":"status","tags":["Status"],"responses":{"200":{"description":"Successful Operation","content":{"application/json":{"schema":{"description":"Successful Operation","type":"object","properties":{"environment":{"description":"API Environment","type":"string"},"version":{"description":"API Version","type":"string"},"requestId":{"description":"Unique request ID","type":"string"}}},"example":{"environment":"pro","version":"1.0.0","requestId":"frer4dtu71Y827iw4upa8tbCjvZ95JnP"}}}},"403":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Invalid Authorization"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Invalid Authorization","requestId":"45u595aN727CCNKkg6lHz4Bp6ZXF9v1k"}}}},"412":{"description":"Error processing request","content":{"application/json":{"schema":{"description":"Error processing request","type":"object","properties":{"time":{"description":"Error time","type":"string"},"message":{"description":"Error message","enum":["Internal server error"],"type":"string"},"requestId":{"description":"Unique request ID","type":"string"}}},"example":{"time":"2021-01-01T00:00:00.000+00:00 (UTC+0)","message":"Internal server error","requestId":"R15Du9L20dtt10Lz1G0Vb2THW16734Af"}}}}},"security":[{"bearerSecurity":[]}]}},"/":{"post":{"description":"All webhooks have the same structure. You can define diferent endpoints for each type of webhook or centralize all calls to the same endpoint","summary":"Webhook.","operationId":"webhhok","tags":["Webhook"],"responses":{"204":{"description":"Success","content":{}}},"requestBody":{"description":"Generic request body sent in webhooks","content":{"application/json":{"schema":{"description":"Generic request body sent in webhooks","type":"object","properties":{"type":{"description":"Type of webhook","enum":["DOCUMENT_STATUS_CHANGE","DOCUMENT_SIGNATURE_STATUS_CHANGE","DOCUMENT_SIGNATURE_AUDIT_CHANGE","DOCUMENT_NEGOTIATION_STATUS_CHANGE","DOCUMENT_VALIDATION_STATUS_CHANGE","DOCUMENT_SHARING_FINISHED","DOCUMENT_SHARING_CREATED","DOCUMENT_SHARING_UPDATED"],"type":"string"},"uids":{"description":"UIDs to identify the resource that caused the webhook to fire","type":"object","properties":{}},"change":{"description":"Values to identify the change that caused the webhook to fire","type":"object","properties":{"previous":{"description":"Previous value for the field that caused the webhook to fire","type":"object","properties":{}},"current":{"description":"Currrent value for the field that caused the webhook to fire","type":"object","properties":{}}}}}}}}}}},"/documentStatusChange":{"post":{"description":"You can define an specific endpoint for webhooks fired when a document changes its status.","summary":"Document status change.","operationId":"documentStatusChange","tags":["Document"],"responses":{"204":{"description":"Success","content":{}}},"requestBody":{"description":"Request body sent when a document changes its status","content":{"application/json":{"schema":{"description":"Request body sent when a document changes its status","type":"object","properties":{"type":{"description":"Type of webhook for document status change","enum":["DOCUMENT_STATUS_CHANGE"],"type":"string"},"uids":{"description":"UIDs to identify the document that caused the webhook to fire","type":"object","properties":{"documentUid":{"description":"A unique identifier that the document belongs to.","type":"string"}}},"change":{"description":"Values to identify the change that caused the webhook to fire","type":"object","properties":{"previous":{"description":"Previous value for the status of the document","type":"object","properties":{"finished":{"description":"Status of the document","type":"string"}}},"current":{"description":"Currrent value for the status of the document","type":"object","properties":{"finished":{"description":"Status of the document","type":"string"}}}}}}},"example":{"type":"DOCUMENT_STATUS_CHANGE","uids":{"documentUid":"49j1036zhTXpGXtKtZqpnvvMg19bN8C5"},"change":{"previous":{"finished":false},"current":{"finished":true}}}}}}}},"/documentSignatureStatusChange":{"post":{"description":"You can define an specific endpoint for webhooks fired when a signature changes its status.","summary":"Signature status change.","operationId":"signatureStatusChange","tags":["DocumentSignature"],"responses":{"204":{"description":"Success","content":{}}},"requestBody":{"description":"Request body sent when a document changes its status","content":{"application/json":{"schema":{"description":"Request body sent when a document changes its status","type":"object","properties":{"type":{"description":"Type of webhook for document status change","enum":["DOCUMENT_SIGNATURE_STATUS_CHANGE"],"type":"string"},"uids":{"description":"UIDs to identify the document that caused the webhook to fire","type":"object","properties":{"documentUid":{"description":"A unique identifier that the document belongs to.","type":"string"},"signatureUid":{"description":"A unique identifier that the signature belongs to.","type":"string"}}},"change":{"description":"Values to identify the change that caused the webhook to fire","type":"object","properties":{"previous":{"description":"Previous value for the status of the signature","type":"object","properties":{"status":{"description":"Status of the signature","enum":["PENDING","PROCESSING","SENT_TO_SIGN","REJECTED","CANCELLED","SIGNED"],"type":"string"}}},"current":{"description":"Currrent value for the status of the signature","type":"object","properties":{"status":{"description":"Status of the signature","enum":["PENDING","PROCESSING","SENT_TO_SIGN","REJECTED","CANCELLED","SIGNED"],"type":"string"}}}}}}},"example":{"type":"DOCUMENT_SIGNATURE_STATUS_CHANGE","uids":{"documentUid":"4iXEh3P3cAZ3GKyw1h0HE82QByEVJQIw","signatureUid":"PH5KSpU1DD3az1170LOthpXKs21bB7ya"},"change":{"previous":{"status":"PENDING"},"current":{"status":"SIGNED"}}}}}}}},"/documentSignatureAuditChange":{"post":{"description":"You can define an specific endpoint for webhooks fired when a signature changes its audit trail flag changes.","summary":"Audit trail flag change.","operationId":"signatureAuditChange","tags":["DocumentSignature"],"responses":{"204":{"description":"Success","content":{}}},"requestBody":{"description":"Request body sent when a document changes its audit trail availability","content":{"application/json":{"schema":{"description":"Request body sent when a document changes its audit trail availability","type":"object","properties":{"type":{"description":"Type of webhook for signature audit available change","enum":["DOCUMENT_SIGNATURE_AUDIT_CHANGE"],"type":"string"},"uids":{"description":"UIDs to identify the document that caused the webhook to fire","type":"object","properties":{"documentUid":{"description":"A unique identifier that the document belongs to.","type":"string"},"signatureUid":{"description":"A unique identifier that the signature belongs to.","type":"string"}}},"change":{"description":"Values to identify the change that caused the webhook to fire","type":"object","properties":{"previous":{"description":"Previous value for the availablility of the audit","type":"object","properties":{"auditAvailable":{"description":"Audit trail available","type":"boolean"}}},"current":{"description":"Currrent value for the availablility of the audit","type":"object","properties":{"auditAvailable":{"description":"Audit trail available","type":"boolean"}}}}}}},"example":{"type":"DOCUMENT_SIGNATURE_AUDIT_CHANGE","uids":{"documentUid":"7u51VIu4Giy0m8oIAOrqZ9p55su4z5s3","signatureUid":"h6vybMN2SGjfOQuUlDYpvObm642tknY6"},"change":{"previous":{"auditAvailable":false},"current":{"auditAvailable":true}}}}}}}},"/documentNegotiationStatusChange":{"post":{"description":"You can define an specific endpoint for webhooks fired when a negotiation changes its status.","summary":"Negotiation status change.","operationId":"negotiationStatusChange","tags":["DocumentNegotiation"],"responses":{"204":{"description":"Success","content":{}}},"requestBody":{"description":"Request body sent when a document changes its status","content":{"application/json":{"schema":{"description":"Request body sent when a document changes its status","type":"object","properties":{"type":{"description":"Type of webhook for document status change","enum":["DOCUMENT_NEGOTIATION_STATUS_CHANGE"],"type":"string"},"uids":{"description":"UIDs to identify the document that caused the webhook to fire","type":"object","properties":{"documentUid":{"description":"A unique identifier that the document belongs to.","type":"string"},"negotiationUid":{"description":"A unique identifier that the negotiation belongs to.","type":"string"}}},"change":{"description":"Values to identify the change that caused the webhook to fire","type":"object","properties":{"previous":{"description":"Previous value for the status of the negotiation","type":"object","properties":{"status":{"description":"Status of the negotiation","enum":["NOT_SENT","PENDING","UNDER_NEGOTIATION","SENT_TO_NEGOTIATE","BACK_TO_NEGOTIATE","CANCELED","FINISHED"],"type":"string"}}},"current":{"description":"Currrent value for the status of the negotiation","type":"object","properties":{"status":{"description":"Status of the negotiation","enum":["NOT_SENT","PENDING","UNDER_NEGOTIATION","SENT_TO_NEGOTIATE","BACK_TO_NEGOTIATE","CANCELED","FINISHED"],"type":"string"}}}}}}},"example":{"type":"DOCUMENT_NEGOTIATION_STATUS_CHANGE","uids":{"documentUid":"32uxyGU4mH2VnSLE161Xrx60JCQn3H6n","negotiationUid":"NNT5E2nSd1WoSkS8p741dMRx2Orw6irB"},"change":{"previous":{"status":"PENDING"},"current":{"status":"FINISHED"}}}}}}}},"/documentValidationStatusChange":{"post":{"description":"You can define an specific endpoint for webhooks fired when a valiation changes its status.","summary":"Validation status change.","operationId":"valiationStatusChange","tags":["DocumentValidation"],"responses":{"204":{"description":"Success","content":{}}},"requestBody":{"description":"Request body sent when a validation changes its status","content":{"application/json":{"schema":{"description":"Request body sent when a validation changes its status","type":"object","properties":{"type":{"description":"Type of webhook for validation status change","enum":["DOCUMENT_VALIDATION_STATUS_CHANGE"],"type":"string"},"uids":{"description":"UIDs to identify the document that caused the webhook to fire","type":"object","properties":{"documentUid":{"description":"A unique identifier that the document belongs to.","type":"string"},"validationUid":{"description":"A unique identifier that the validation belongs to.","type":"string"}}},"change":{"description":"Values to identify the change that caused the webhook to fire","type":"object","properties":{"previous":{"description":"Previous value for the status of the validation","type":"object","properties":{"status":{"description":"Status of the validation","enum":["STARTED","UNDER_VALIDATION","CHANGES_REQUESTED","CANCELED","APPROVED"],"type":"string"}}},"current":{"description":"Currrent value for the status of the validation","type":"object","properties":{"status":{"description":"Status of the validation","enum":["STARTED","UNDER_VALIDATION","CHANGES_REQUESTED","CANCELED","APPROVED"],"type":"string"}}}}}}},"example":{"type":"DOCUMENT_VALIDATION_STATUS_CHANGE","uids":{"documentUid":"s5KHzAs3EEG7FNUsa1qxzFe39VqZqf67","validationUid":"3k1uB22R7Zw5ROx1336ePTH5QwH8s7gD"},"change":{"previous":{"status":"STARTED"},"current":{"status":"APPROVED"}}}}}}}},"/documentSharingCreated":{"post":{"description":"You can define an specific endpoint for webhooks fired when a document sharing is created.","summary":"Document sharing created.","operationId":"documentSharingCreated","tags":["DocumentSharing"],"responses":{"204":{"description":"Success","content":{}}},"requestBody":{"description":"Request body sent when a document sharing is created","content":{"application/json":{"schema":{"description":"Request body sent when a document sharing is created","type":"object","properties":{"type":{"description":"Type of webhook for document sharing created","enum":["DOCUMENT_SHARING_FINISHED"],"type":"string"},"uids":{"description":"UIDs to identify the document sharing that caused the webhook to fire","type":"object","properties":{"documentUid":{"description":"A unique identifier that the document belongs to.","type":"string"},"documentSharingUid":{"description":"A unique identifier that the document sharing belongs to.","type":"string"}}},"change":{"description":"Values to identify the change that caused the webhook to fire","type":"object","properties":{"current":{"description":"Currrent value for the origin field","type":"object","properties":{"origin":{"description":"Origin value","type":"boolean"}}}}}}},"example":{"type":"DOCUMENT_SHARING_FINISHED","uids":{"documentUid":"E786O24m4DGaD8uB9HS1u0gEbTz96B7w","documentSharingUid":"qmcYc6auLJWNWcPl7ey9bjPX7mJC6fT8"},"change":{"current":{"origin":"API"}}}}}}}},"/documentSharingUpdated":{"post":{"description":"You can define an specific endpoint for webhooks fired when a document sharing is updated.","summary":"Document sharing updated.","operationId":"documentSharingUpdated","tags":["DocumentSharing"],"responses":{"204":{"description":"Success","content":{}}},"requestBody":{"description":"Request body sent when a document sharing is updated. The webhook is triggered 10 minutes after the last update.","content":{"application/json":{"schema":{"description":"Request body sent when a document sharing is updated. The webhook is triggered 10 minutes after the last update.","type":"object","properties":{"type":{"description":"Type of webhook for document sharing updated","enum":["DOCUMENT_SHARING_UPDATED"],"type":"string"},"uids":{"description":"UIDs to identify the document sharing that caused the webhook to fire","type":"object","properties":{"documentUid":{"description":"A unique identifier that the document belongs to.","type":"string"},"documentSharingUid":{"description":"A unique identifier that the document sharing belongs to.","type":"string"}}},"change":{"description":"Values to identify the change that caused the webhook to fire","type":"object","properties":{"current":{"description":"Currrent value for the form content","type":"object","properties":{"main":{"description":"Form content. It depends on the template being used","type":"object","properties":{}}}}}}}},"example":{"type":"DOCUMENT_SHARING_UPDATED","uids":{"documentUid":"d975O482lma2FQ6S4kEbtmXW6O0aP68u","documentSharingUid":"mHBLioAa7z0q8ZbBPn5fn2XT1h2Ee0y7"},"change":{"current":{"main":{}}}}}}}}},"/documentSharingFinished":{"post":{"description":"You can define an specific endpoint for webhooks fired when a document sharing is finished.","summary":"Document sharing finished.","operationId":"documentSharingFinished","tags":["DocumentSharing"],"responses":{"204":{"description":"Success","content":{}}},"requestBody":{"description":"Request body sent when a document sharing is finished","content":{"application/json":{"schema":{"description":"Request body sent when a document sharing is finished","type":"object","properties":{"type":{"description":"Type of webhook for document sharing finished","enum":["DOCUMENT_SHARING_FINISHED"],"type":"string"},"uids":{"description":"UIDs to identify the document sharing that caused the webhook to fire","type":"object","properties":{"documentUid":{"description":"A unique identifier that the document belongs to.","type":"string"},"documentSharingUid":{"description":"A unique identifier that the document sharing belongs to.","type":"string"}}},"change":{"description":"Values to identify the change that caused the webhook to fire","type":"object","properties":{"previous":{"description":"Previous value for the finished flag","type":"object","properties":{"finished":{"description":"Finished flag","type":"boolean"}}},"current":{"description":"Currrent value for the finished flag","type":"object","properties":{"finished":{"description":"Finished flag","type":"boolean"}}}}}}},"example":{"type":"DOCUMENT_SHARING_FINISHED","uids":{"documentUid":"Iv3SYSAVfw2h4mYE0azcbc8L4rvMuL5j","documentSharingUid":"9mS0gOMHG3aoogKzveDh520jeS10I4dV"},"change":{"previous":{"finished":false},"current":{"finished":true}}}}}}}}},"servers":[{"url":"https://defined_by_client.com"}],"components":{"securitySchemes":{"bearerSecurity":{"type":"http","scheme":"bearer"}}}}