Register webhook - Millwork

POST

/

v1

/

webhooks

Register webhook

curl --request POST \
  --url https://api.getmillwork.dev/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [],
  "url": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({events: [], url: '<string>'})
};

fetch('https://api.getmillwork.dev/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "created_at": "2023-11-07T05:31:56Z",
  "events": [
    "execution.completed"
  ],
  "secret_version": 123,
  "signing_secret": "<string>",
  "status": "active",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "webhook_id": "<string>"
}

{
  "instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "current_offer": {
    "content_markdown": "<string>",
    "display_label": "<string>",
    "document_id": "<string>",
    "offer_id": "<string>",
    "published_url": "<string>",
    "source_sha256": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "version_id": "<string>"
  },
  "current_organization": {
    "legal_entity_name": "<string>",
    "profile_revision": 2
  },
  "detail": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "reason": "agreement_terminated",
  "retry_after_s": 123
}

{
  "instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "current_offer": {
    "content_markdown": "<string>",
    "display_label": "<string>",
    "document_id": "<string>",
    "offer_id": "<string>",
    "published_url": "<string>",
    "source_sha256": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "version_id": "<string>"
  },
  "current_organization": {
    "legal_entity_name": "<string>",
    "profile_revision": 2
  },
  "detail": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "reason": "agreement_terminated",
  "retry_after_s": 123
}

{
  "instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "current_offer": {
    "content_markdown": "<string>",
    "display_label": "<string>",
    "document_id": "<string>",
    "offer_id": "<string>",
    "published_url": "<string>",
    "source_sha256": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "version_id": "<string>"
  },
  "current_organization": {
    "legal_entity_name": "<string>",
    "profile_revision": 2
  },
  "detail": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "reason": "agreement_terminated",
  "retry_after_s": 123
}

Authorizations

Authorization

string

header

required

Organization API key for application requests.

Body

application/json

events

enum<string>[]

required

Minimum array length: 1

Available options:

execution.completed,

execution.failed,

execution.needs_review,

proposal.created

url

string<uri>

required

Maximum string length: 2048

Response

Default Response

created_at

string<date-time>

required

events

enum<string>[]

required

Available options:

execution.completed,

execution.failed,

execution.needs_review,

proposal.created

secret_version

integer

required

signing_secret

string

required

The raw signing secret. Revealed exactly once, at registration or rotation; store it now.

status

enum<string>

required

Available options:

active,

disabled

updated_at

string<date-time>

required

url

string<uri>

required

webhook_id

string

required

Register webhook

curl --request POST \
  --url https://api.getmillwork.dev/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [],
  "url": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({events: [], url: '<string>'})
};

fetch('https://api.getmillwork.dev/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "created_at": "2023-11-07T05:31:56Z",
  "events": [
    "execution.completed"
  ],
  "secret_version": 123,
  "signing_secret": "<string>",
  "status": "active",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "webhook_id": "<string>"
}

{
  "instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "current_offer": {
    "content_markdown": "<string>",
    "display_label": "<string>",
    "document_id": "<string>",
    "offer_id": "<string>",
    "published_url": "<string>",
    "source_sha256": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "version_id": "<string>"
  },
  "current_organization": {
    "legal_entity_name": "<string>",
    "profile_revision": 2
  },
  "detail": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "reason": "agreement_terminated",
  "retry_after_s": 123
}

{
  "instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "current_offer": {
    "content_markdown": "<string>",
    "display_label": "<string>",
    "document_id": "<string>",
    "offer_id": "<string>",
    "published_url": "<string>",
    "source_sha256": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "version_id": "<string>"
  },
  "current_organization": {
    "legal_entity_name": "<string>",
    "profile_revision": 2
  },
  "detail": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "reason": "agreement_terminated",
  "retry_after_s": 123
}

{
  "instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "current_offer": {
    "content_markdown": "<string>",
    "display_label": "<string>",
    "document_id": "<string>",
    "offer_id": "<string>",
    "published_url": "<string>",
    "source_sha256": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "version_id": "<string>"
  },
  "current_organization": {
    "legal_entity_name": "<string>",
    "profile_revision": 2
  },
  "detail": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "reason": "agreement_terminated",
  "retry_after_s": 123
}