Jira HTTP Ingest (Webhook)

The Jira HTTP Ingest connector allows you to capture data from incoming HTTP requests from Jira. A common use case is to capture webhook deliveries, turning them into an Estuary collection.

Usage

Configure a Jira webhook

1. To begin, use the dashboard to create a capture. Once published, the connector overview displays a unique URL for your public endpoint.

2. In the Jira Administration console press the . key to bring up Jira's search. Search for Webhooks.

3. Click on Create a WebHook and in the url section input the url that was generated after publishing a capture in Estuary. See the Webhook URLs section below for more information on the structure of your URL.

Review Jira's documentation on configuring a webhook for more information.

Webhook URLs

To determine the full URL, start with the base URL from the Estuary web app (for example https://abc123-8080.us-central1.v1.estuary-data.dev), and then append the path.

The path will be whatever is in the paths endpoint configuration field (/webhook-data by default). For example, your full webhook URL would be https://<your-unique-hostname>/webhook-data. You can add additional paths to paths, and the connector will accept webhook requests on each of them. Each path will correspond to a separate binding. If you're editing the capture via the UI, click the "re-fresh" button after editing the URL paths in the endpoint config to see the resulting collections in the bindings editor. For example, if you set the path to /my-webhook.json, then the full URL for that binding would be https://<your-unique-hostname>/my-webhook.json.

Any URL query parameters that are sent on the request will be captured and serialized under /_meta/query/* in the documents. For example, a webhook request that's sent to /webhook-data?testKey=testValue would result in a document like:

{
  "_meta": {
    "webhookId": "...",
    "query": {
      "testKey": "testValue"
    },
    ...
  }
  ...
}

Authentication

The connector can optionally require each request to present an authentication token as part of an Authorization: Bearer HTTP header. To enable authentication, generate a secret and paste it into the "Require Auth Token" field. We recommend using a password manager to generate these values, but keep in mind that not all systems will be able to send values with certain special characters, so you may want to disable special characters when you generate the secret. If you enable authentication, then each incoming request must have an Authorization header with the value of your token. For example, if you use an auth token value of mySecretToken, then the header on each request must be Authorization: Bearer mySecretToken.

If you don't enable authentication, then anyone who knows the URL will be able to publish data to your collection. We recommend using authentication whenever possible.

Webhook signature verification

This connector supports HMAC-SHA256 signature verification so you can receive secured Jira webhooks. To enable signature verification, update your connector's signatureConfig and use X-Hub-Signature as the signature header.

{
  "signatureConfig": {
    "provider": "custom",
    "algorithm": "hmac_sha256",
    "publicKey": "your-shared-secret",
    "signatureHeader": "X-Hub-Signature",
    "signingStringTemplate": "{PAYLOAD}"
  }
}

Configuration

Endpoint properties

Property	Title	Description	Type	Required/Default
/requireAuthToken		Optional bearer token to authenticate webhook requests. WARNING: If this is empty or unset, then anyone who knows the URL of the connector will be able to write data to your collections.	null, string	null
/paths	URL Paths	List of URL paths to accept requests at. Discovery will return a separate collection for each given path. Paths must be provided without any percent encoding, and should not include any query parameters or fragment.	null, string	null
/allowedCorsOrigins	CORS Allowed Origins	List of allowed CORS origins. Set to an empty array to disable CORS. Must not include * when an authentication token is configured.	string array	["*"]
/signatureConfig	Signature Verification	Configuration for verifying webhook signatures.	object	{"provider": "none"}

See custom signature configs for the full list of signature configuration properties.

Resource properties

Property	Title	Description	Type	Required/Default
/idFromHeader		Set the /_meta/webhookId from the given HTTP header in each request. If not set, then a random id will be generated automatically. If set, then each request will be required to have the header, and the header value will be used as the value of `/_meta/webhookId`.	null, string
/path		The URL path to use for adding documents to this binding. Defaults to the name of the collection.	null, string
/stream		The name of the binding, which is used as a merge key when doing Discovers.	null, string

Sample

captures:
  ${PREFIX}/${CAPTURE_NAME}:
    endpoint:
      connector:
        image: ghcr.io/estuary/source-jira-ingest:v1
        config:
          paths:
            - /webhook-data
          signatureConfig:
            provider: none
    bindings:
      - resource:
          path: /webhook-data
          stream: /webhook-data
        target: ${PREFIX}/${COLLECTION_NAME}