Verify workflow notification channel

Verify a workflow-scoped notification channel using a verification code.

POST /api/v1/workflows/{workflow_id}/notifications/channels/{channel_id}/verify

cURL

curl --request POST \
  --url "${UNSTRUCTURED_API_URL}/api/v1/workflows/f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c/notifications/channels/c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f/verify" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{
    "verification_code": "123456"
  }'

Response

{}

Email channels require verification. A 6-digit verification code is sent to the recipient email address when the channel is created. Webhook channels do not require verification.

Path parameters

workflow_id · string · required

The unique identifier of the workflow.

channel_id · string · required

The unique identifier of the notification channel to verify.

Body

verification_code · string · required

The 6-digit verification code sent to the recipient email address during channel creation.

cURL

curl --request POST \
  --url "${UNSTRUCTURED_API_URL}/api/v1/workflows/f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c/notifications/channels/c1d2e3f4-5a6b-7c8d-9e0f-1a2b3c4d5e6f/verify" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}" \
  --header "Content-Type: application/json" \
  --data '{
    "verification_code": "123456"
  }'

Response

{}