{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":21247,"path":"integrate-applications/integration-hub/govnotify-setup.md","title":"Set up the GovNotify spoke","bundle":null,"doc_type":null,"release":"australia","body":"\n# Set up the GovNotify spoke\n\nIntegrate ServiceNow instance and GovNotify account using JWT authentication to authenticate ServiceNow requests.\n\n## Before you begin\n\n-   Request an Integration Hub subscription.\n-   Activate the GovNotify spoke.\n-   Role required: admin.\n\n## Procedure\n\n1.  In the GovNotify account, create an API key.\n\n    1.  Log in to your GovNotify account as admin.\n\n    2.  Navigate to **API integration** and click **API Keys**.\n\n    3.  Click **Create an API key**.\n\n    4.  On the form, provide a name for the API key and select the required key type.\n\n        \\[Omitted image \"govnotify-api.png\"\\] Alt text: Create an API key.\n\n    5.  Click **Continue**.\n\n        The API key is displayed in this format: `{key_name}-{iss-uuid}-{secret-key-uuid}`. For example, if the API key is `my_test_key-26785a09-ab16-4eb0-8407-a37497a57506-3d844edf-8d35-48ac-975b-e847b4f122b0`:\n\n        -   API key name is: `my_test_key`\n        -   iss \\(service id\\) is: `26785a09-ab16-4eb0-8407-a37497a57506`\n        -   secret key or signing key is: `3d844edf-8d35-48ac-975b-e847b4f122b0`\n        For more information, see [Headers](https://docs.notifications.service.gov.uk/rest-api.html#headers) in [GovNotify REST API documentation](https://docs.notifications.service.gov.uk/rest-api.html#rest-api-documentation).\n\n    6.  Click **Copy API key to clipboard** and record the value for later use.\n\n        \\[Omitted image \"govnotify-copy-api.png\"\\] Alt text: Copy the API key.\n\n2.  Configure the default JWT key record in your ServiceNow instance.\n\n    1.  Navigate to **System OAuth** > **JWT Keys**.\n\n    2.  Open the record, **GovNotify Key**.\n\n    3.  Enter the signing key you had copied from the API key in **Signing key**.\n\n    4.  Click **Update**.\n\n3.  Configure the default JWT provider record in your ServiceNow instance.\n\n    1.  Navigate to **System OAuth** > **JWT Providers**.\n\n    2.  Open the record, **GovNotify JWT Provider**.\n\n    3.  In the **Standard claims** tab, click the **iss** record.\n\n    4.  Enter the iss \\(service id\\) value you had copied from the API key in **Claim value**.\n\n    5.  Click **Update**.\n\n4.  Configure the default credential record in your ServiceNow instance.\n\n    1.  Navigate to **GovNotify Spoke** > **Credentials**.\n\n    2.  Open the record, **GovNotify Cred**.\n\n    3.  For **JWT Provider**, select the JWT provider you had configured.\n\n    4.  Click **Update**.\n\n5.  Configure the default connection and credential alias record in your ServiceNow instance.\n\n    1.  Navigate to **Connections & Credentials** > **Connection & Credential Aliases**.\n\n    2.  Open the record, **GovNotify**.\n\n    3.  In the **Connections** tab, click **New**.\n\n    4.  On the form, fill these values.\n\n        |Field|Description|\n        |-----|-----------|\n        |Credential|Credential record you had configured. For example, `GovNotify Cred`.|\n        |Connection URL|URL to connect to GovNotify account. Enter `https://api.notifications.service.gov.uk`.|\n\n    5.  Click **Submit**.\n\n\n"}}