Quickstart

This quickstart takes you from nothing to a working API call. It's the fastest way to confirm your integration can talk to intSignal.

Prerequisites

• Access to the Portal with permission to create API keys.
• A terminal (for curl), or Node.js / Python if you prefer.

1. Create an API key

In the Portal, go to Settings → API keys, create a key, and scope it to only what your integration needs (for example soc:read). Copy the secret — it's shown once — and export it:

export INTSIGNAL_TOKEN="paste-your-key-here"

2. Make your first request

Confirm the key works with a simple read:

curl https://api.intsignal.com/v1/ping \
  -H "Authorization: Bearer $INTSIGNAL_TOKEN"

A 200 OK with a JSON body means you're connected. A 401 means the token is missing or wrong; a 403 means the key is valid but lacks the required scope.

3. Read some data

List a resource — here, recent SOC cases (needs soc:read):

curl "https://api.intsignal.com/v1/soc/cases?limit=5" \
  -H "Authorization: Bearer $INTSIGNAL_TOKEN" \
  -H "Accept: application/json"

{
  "data": [
    { "id": "case_8f21c0", "title": "Impossible-travel sign-in", "severity": "high" }
  ],
  "next_cursor": "eyJvIjoxMDB9"
}

That next_cursor is how you page through more results — see Code examples.

Next steps

• Copy-paste code examples in curl, JavaScript, and Python
• Understand pagination, filtering, and errors
• React to events in real time with webhooks
• Try common integration recipes