Skip to main content

Webhook receiver for External CI Events

POST 
/ci/webhook

External CI communication endpoint, provides a way to send CI events to CodeNow.
Supported events:

Start event: indicates the start of a pipeline run. (once per run).
Result event: event with a payload with results of the pipeline run (git information, container/helm artifacts produced, etc).
End event: indicates the end of a pipeline run (once per run).

To use this interface, you need to have a valid CI key with the scope corresponding to the component (or with account scope).

Request​

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Body

required

    oneOf


    Event that indicates the start of a pipeline run.
    Only one event of this type must be sent per pipelineId.

    type stringrequired

    Possible values: non-empty

    Default value: codenow.ci.start.event


    The type of the event.

    version stringrequired

    Possible values: non-empty

    Default value: application/vnd.codenow.v1+json


    The version of the event.

    pipelineId stringrequired

    Possible values: non-empty


    Correlation ID of the pipeline run, all events of the same build must have the same pipelineId.

    createdAt date-timenullable


    Timestamp of the event.

    componentId stringrequired

    Possible values: non-empty


    CodeNOW id of the library / application component to be build.

    buildVersion stringrequired


    Version of the library / application component to be build.

    actor

    object

    nullable


    Actor that triggered the pipeline.

    username stringrequired

    Possible values: non-empty


    The username of the actor.

    fullname stringnullable


    The full name of the actor.

    pipelineName string


    The name of the pipeline.

    dashboardUrl string


    The URL of the dashboard where details of the build can be accessed through the CodeNOW UI.

    type

    string

    required

    Possible values: [codenow.ci.start.event, codenow.ci.end.event, codenow.ci.result.event]


    The type of the event.

    type stringrequired

    Possible values: non-empty

    Default value: codenow.ci.start.event


    The type of the event.

    version stringrequired

    Possible values: non-empty

    Default value: application/vnd.codenow.v1+json


    The version of the event.

    pipelineId stringrequired

    Possible values: non-empty


    Correlation ID of the pipeline run, all events of the same build must have the same pipelineId.

    createdAt date-timenullable


    Timestamp of the event.

    componentId stringrequired

    Possible values: non-empty


    CodeNOW id of the library / application component to be build.

    buildVersion stringrequired


    Version of the library / application component to be build.

    actor

    object

    nullable


    Actor that triggered the pipeline.

    username stringrequired

    Possible values: non-empty


    The username of the actor.

    fullname stringnullable


    The full name of the actor.

    pipelineName string


    The name of the pipeline.

    dashboardUrl string


    The URL of the dashboard where details of the build can be accessed through the CodeNOW UI.

    version stringrequired

    Possible values: non-empty


    The version of the event.

    pipelineId stringrequired


    Correlation ID of the pipeline run, all events of the same build must have the same pipelineId.

    createdAt date-time


    Timestamp of the event.

Responses​

ci-webhook 200 response

Schema

    status stringrequired

    Possible values: non-empty

Loading...