Twenty•2mo ago

Help creating notes via API - BodyV2

Are both blocknote and markdown required? This appears to be the case but is somewhat redundant.

"bodyV2": {
    "blocknote": "string",
    "markdown": "string"
  }

"bodyV2": {
    "blocknote": "string",
    "markdown": "string"
  }

7 Replies

ɃØĦɆᵾS•2mo ago

@John from testing it looks like both aren't required since record'll be created anyway but definitely the bodyV2 must be (even if empty like "bodyV2": {},), otherwise there'll be problem with sending webhook if you have them enabled But I can't get to create them properly with filled body so please confirm if you too can't create them properly

JohnOP•2mo ago

To clarify, the note itself creates, although I cannot get the body to appear. I assume this is the same issue you are having.

ɃØĦɆᵾS•2mo ago

I think I've found the solution In order to create a note record, you have to give a bodyV2.blocknote part, otherwise record won't have a visible body in UI (even though body was populated properly in DB) so you don't have to give a markdown The caveat with it is fact you can't create proper note record without bodyV2.blocknote as that's the rendered part in UI and it seems like there's no conversion in API from markdown to blocknote, also, in blocknote you need to have UUIDs as id of specific part like paragraph

JohnOP•2mo ago

I'm not sure I am totally tracking. Can you share your example?

ɃØĦɆᵾS•2mo ago

Sure, one sec Here's body of API request with only markdown which will result in creating a note record but without a visible body

{
  "position": 0,
  "title": "Test4",
  "body": null,
  "bodyV2": {
          "markdown": "test4\n\ntest3\n\n# test1\n"
  },
  "createdBy": {
    "source": "EMAIL"
  }
}

{
  "position": 0,
  "title": "Test4",
  "body": null,
  "bodyV2": {
          "markdown": "test4\n\ntest3\n\n# test1\n"
  },
  "createdBy": {
    "source": "EMAIL"
  }
}

And here's body of API request with only blocknote which will result in creating a note record with visible body

{
  "position": 0,
  "title": "Test2",
  "body": null,
  "bodyV2": {
              "blocknote": "[{\"id\":\"667d8854-6dbf-42be-bd18-92f73aa24313\",\"type\":\"paragraph\",\"props\":{\"textColor\":\"default\",\"backgroundColor\":\"default\",\"textAlignment\":\"left\"},\"content\":[{\"type\":\"text\",\"text\":\"test4\",\"styles\":{}}],\"children\":[]},{\"id\":\"51907a1e-5205-43b7-b175-e9636ee7da00\",\"type\":\"paragraph\",\"props\":{\"textColor\":\"default\",\"backgroundColor\":\"default\",\"textAlignment\":\"left\"},\"content\":[{\"type\":\"text\",\"text\":\"test3\",\"styles\":{}}],\"children\":[]},{\"id\":\"d6f1858a-0744-4c61-800d-49a6f70d2e28\",\"type\":\"heading\",\"props\":{\"textColor\":\"default\",\"backgroundColor\":\"default\",\"textAlignment\":\"left\",\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"test1\",\"styles\":{}}],\"children\":[]},{\"id\":\"b6b2f995-ae1e-414d-be7d-908ef6175b38\",\"type\":\"paragraph\",\"props\":{\"textColor\":\"default\",\"backgroundColor\":\"default\",\"textAlignment\":\"left\"},\"content\":[],\"children\":[]},{\"id\":\"344412d1-1778-45ad-bfd0-64a40674ba8c\",\"type\":\"paragraph\",\"props\":{\"textColor\":\"default\",\"backgroundColor\":\"default\",\"textAlignment\":\"left\"},\"content\":[],\"children\":[]}]"
  },
  "createdBy": {
    "source": "EMAIL"
  }
}

{
  "position": 0,
  "title": "Test2",
  "body": null,
  "bodyV2": {
              "blocknote": "[{\"id\":\"667d8854-6dbf-42be-bd18-92f73aa24313\",\"type\":\"paragraph\",\"props\":{\"textColor\":\"default\",\"backgroundColor\":\"default\",\"textAlignment\":\"left\"},\"content\":[{\"type\":\"text\",\"text\":\"test4\",\"styles\":{}}],\"children\":[]},{\"id\":\"51907a1e-5205-43b7-b175-e9636ee7da00\",\"type\":\"paragraph\",\"props\":{\"textColor\":\"default\",\"backgroundColor\":\"default\",\"textAlignment\":\"left\"},\"content\":[{\"type\":\"text\",\"text\":\"test3\",\"styles\":{}}],\"children\":[]},{\"id\":\"d6f1858a-0744-4c61-800d-49a6f70d2e28\",\"type\":\"heading\",\"props\":{\"textColor\":\"default\",\"backgroundColor\":\"default\",\"textAlignment\":\"left\",\"level\":1},\"content\":[{\"type\":\"text\",\"text\":\"test1\",\"styles\":{}}],\"children\":[]},{\"id\":\"b6b2f995-ae1e-414d-be7d-908ef6175b38\",\"type\":\"paragraph\",\"props\":{\"textColor\":\"default\",\"backgroundColor\":\"default\",\"textAlignment\":\"left\"},\"content\":[],\"children\":[]},{\"id\":\"344412d1-1778-45ad-bfd0-64a40674ba8c\",\"type\":\"paragraph\",\"props\":{\"textColor\":\"default\",\"backgroundColor\":\"default\",\"textAlignment\":\"left\"},\"content\":[],\"children\":[]}]"
  },
  "createdBy": {
    "source": "EMAIL"
  }
}

In short, you have to use blocknote if you want to have a visible body of note record in UI

JohnOP•2mo ago

Opened an issue here

GitHub

Note body not visible when via API with bodyV2 without blocknote · ...

Bug Description Creating a note via API with bodyV2 and without a blocknote component will not allow the body component to be visible in the UI despite a successful API call. Inputting markdown tex...

Lucas•2mo ago

Thanks, we'll look into it

Gaming

Programming

Help creating notes via API - BodyV2

Did you find this page helpful?