Skip to navigation

Export

Export the artifact to Notion, Confluence or Google Docs, as the signed-in person, through their own account in the tool (connected from Export on a launch artifact in LaunchCal): never a shared account, so a workspace key is refused (person_required). The first export makes a page (destinationId says where, from GET /docs-tools/{tool}/destinations; Google Docs makes a new doc in their Drive); a later one updates that same page, title and all, unless asNew. When the earlier page cannot be reached with this person’s account, a new one is made where destinationId says, and outcome is replaced. The link is kept on the artifact (exports). Writing it changes the launch, so a Viewer of LaunchCal is refused. Counts against docs-export. Needs artifacts:write. An artifact with nothing written in it is 409 artifact_empty, a tool this deployment does not export to 409 docs_tool_unavailable, a tool the person has not connected 409 docs_not_connected, a connection the tool turned down 409 docs_reconnect, a destinationId that cannot take a page or that their account cannot reach 409 docs_destination_invalid, and a tool that did not answer 502 upstream_error.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

launchIdstringRequired
typeenumRequired
Allowed values:

Request

This endpoint expects an object.
toolenumRequired
Allowed values:
destinationIdstringOptional

Where a new page goes: a Notion page’s or Confluence space’s id from GET /docs-tools/{tool}/destinations. Not needed for Google Docs, nor to update the page an earlier export made.

titlestringOptional

The page’s title; by default the launch’s name and the artifact’s.

asNewbooleanOptional
Make a new page even when the earlier one could be updated.

Response

This endpoint returns an object.
outcomeenum
Allowed values:
exportobject

Where an artifact was last exported to in one docs tool: a page or doc made with the exporter’s own account there, which they own.

artifactobject

A document attached to a launch: the press release written before the work starts, the dashboard watched during it, and the learnings captured after.

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Validation Error
429
Too Many Requests Error
429
Too Many Requests Error
502
Upstream Error