Skip to main content

Check out Port for yourself 

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

    identifierstring

    A unique identifier for the webhook.

    Possible values: <= 30 characters

    titlestringrequired

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

    Possible values: <= 30 characters

    descriptionstring

    A description for the webhook.

    Possible values: <= 200 characters

    iconstring

    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 [

    • blueprintstringrequired

    The identifier of the blueprint to map the data into.

    filterstring

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

    itemsToParsestring

    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.

    identifierstringrequired

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

    titlestring

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

    iconstring

    The icon of the entity.

    teamstring

    The team the entity belongs to.

    propertiesobject

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

    relationsobject

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

  • ]

    • enabledbooleanrequired

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

    Default value: true

    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.

    secretstring
    signatureHeaderNamestring
    signatureAlgorithmstring

    Possible values: [sha1, sha256, plain]

    signaturePrefixstring
    requestIdentifierPathstring
    integrationTypestring

    Possible values: [custom]

Responses​

Default Response

Last updated on