Skip to main content

Create a webhook

POST 
/v1/webhooks

This route allows you to create a webhook in your Port organization. Webhooks provide a way to ingest data from an external tool/platform into Port. You can also create a webhook via the data sources page of your Port account.

To learn more about webhooks, check out the documentation.

Request​

Body

required

    identifier string

    Possible values: <= 30 characters

    A unique identifier for the webhook.

    title stringrequired

    Possible values: <= 30 characters

    The title of the webhook, which will be displayed in the data sources page of your Port account.

    description string

    Possible values: <= 200 characters

    A description for the webhook.

    icon string

    The icon of the webhook.

    mappings

    object[]

    The mapping definitions used to map the data from the webhook into Port entities. For more information and examples, check out the documentation.

  • Array [

    • blueprint stringrequired

    The identifier of the blueprint to map the data into.

    filter string

    A jq query used to filter exactly which payloads sent to the webhook are processed. If set to "true", all payloads will be processed.

    itemsToParse string

    A jq query that evaluates to an array of items, used to create multiple entities from a single webhook event.

    entity

    object

    required

    An object defining how to map the data from the webhook payload into Port entities.

    identifier stringrequired

    A jq expression used to get data from the webhook payload, to be used as an identifier for the entity.

    title string

    A jq expression used to get data from the webhook payload, to be used as the title of the entity.

    icon string

    The icon of the entity.

    team string

    The team the entity belongs to.

    properties object

    An object containing the properties of the entity and their values. For more information and examples, check out the documentation.

    relations object

    An object containing the relations of the entity and their values. For more information and examples, check out the documentation.

  • ]

    • enabled booleanrequired

    Default value: true

    Determines whether the webhook is active or not. If false, any incoming events will be dropped.

    security

    object

    The security configuration of the webhook, used to tell Port how to verify the hashed signature sent with incoming requests.
    For more information and examples, check out the documentation.

    secret string
    signatureHeaderName string
    signatureAlgorithm string

    Possible values: [sha1, sha256, plain]

    signaturePrefix string
    requestIdentifierPath string
    integrationType string

    Possible values: [custom]

Responses​

Default Response

Loading...
Last updated on