Webhooks

Events that can be sent to your custom application

Webhooks are used to send data to your application when certain events happen. To configure webhooks, go to your API Settings page and enter a URL endpoint that will collect data that we POST to it.

Proposal Open Webhook

This webhook is triggered when a recipient opens the proposal.

Example POST:

{
  "event": "PROPOSAL_OPEN",
  "timestamp": "2019-03-29T22:49:45+0000",
  "signature": {
    "signature": "9533d8d409cf77f4bfebe872b69fafd3183320aa1f13fbfd51ac53505d9709ea",
    "token": "9bcff8b9-179e-4b1d-88d8-3b22a6a0ea0d",
    "nonce": "1553899785915408"
  },
  "data": {
    "proposalId": "7a5ef450-7150-480f-bda2-5afb50640358",
    "recipientId": "d95eeabd-3c97-4a4e-8eef-0655aad4947b",
    "openDate": "2019-03-29T22:49:45+0000"
  }
}

Proposal State Change Webhook

This webhook is triggered when the state is changed. Example, when a proposal is published, this will trigger a state change.

Example POST:

{
  "event": "PROPOSAL_STATE_CHANGE",
  "timestamp": "2019-03-29T22:49:45+0000",
  "signature": {
    "signature": "9533d8d409cf77f4bfebe872b69fafd3183320aa1f13fbfd51ac53505d9709ea",
    "token": "9bcff8b9-179e-4b1d-88d8-3b22a6a0ea0d",
    "nonce": "1553899785915408"
  },
  "data": {
    "proposalId": "7a5ef450-7150-480f-bda2-5afb50640358",
    "userId": "6b4a6af6-3b3a-40a5-80ec-aa576ef7f8ac",
    "newState": "PUBLISHED",
    "oldState": "UNPUBLISHED",
    "stateChangeDate": "2019-03-29T22:49:45+0000"
  }
}

Proposal Signed Webhook

This webhook is triggered when the signatory of your proposal signs off (accepts) the proposal.

Example POST:

{
  "event": "PROPOSAL_SIGNED",
  "timestamp": "2019-03-29T22:49:45+0000",
  "signature": {
    "signature": "9533d8d409cf77f4bfebe872b69fafd3183320aa1f13fbfd51ac53505d9709ea",
    "token": "9bcff8b9-179e-4b1d-88d8-3b22a6a0ea0d",
    "nonce": "1553899785915408"
  },
  "data": {
    "proposalId": "7a5ef450-7150-480f-bda2-5afb50640358",
    "recipientId": "d95eeabd-3c97-4a4e-8eef-0655aad4947b",
    "newState": "WON",
    "wonDate": "2019-03-29T22:49:45+0000"
  }
}