> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.nilo.services/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.nilo.services/_mcp/server.

# Criar ou desligar uma assinatura

POST https://landing-zone-api.nilo.services/fhir/resources/Subscription
Content-Type: application/json

Cria uma assinatura de webhook, com `status: requested`, ou desliga uma existente, com `status: off`. Só o canal `rest-hook` é suportado.

Reference: https://api-docs.nilo.services/referencia/endpoints/subscription/create

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Servers

- `https://landing-zone-api.nilo.services` (Production, default)
- `https://landing-zone-api.stg.nilo.services` (Staging)

## Request

### Body (application/json)

This endpoint expects a Subscription.

- `resourceType` (string, required, default: Subscription) — Indica o tipo do recurso transacionado.
- `status` (string, required) — **Obrigatório.** Na criação, tem de ser `requested`. Para desligar uma assinatura, envie `off`. A leitura devolve também `active`, depois do aperto de mão, e `error`, quando ele falhou.
- `criteria` (string, required) — **Obrigatório.** O tipo de recurso a observar — `Patient`, `Encounter` —, opcionalmente com parâmetros de busca depois de `?`. O tipo tem de ser um recurso FHIR válido.
- `reason` (string, required) — **Obrigatório pelo FHIR**, e sem efeito na plataforma: o texto é seu. Depois da primeira mudança de situação da assinatura, a leitura passa a devolver `-`.
- `channel` (Subscription_Channel, required) — **Obrigatório.** Para onde a notificação vai.
- `id` (string, optional) — Só resposta: identificador Nilo FHIR da assinatura.
- `meta` (Subscription_Meta, optional) — Traz, em `tag[0].code`, o identificador da assinatura na plataforma. Este recurso não tem `identifier`, e é por essa etiqueta que ele é reencontrado.
- `contact` (list of ContactPoint, optional) — Contatos para avisos sobre a assinatura. Só `system: email` é aceito, e o endereço é validado.
- `end` (string, optional) — Só resposta: preenchido quando a assinatura é desligada.
- `error` (string, optional) — Só resposta: o erro que derrubou o aperto de mão, quando o `status` é `error`.

## Response

### 200

Assinatura criada ou desligada. O corpo é o recurso como ficou gravado, sem envelope.

- `resourceType` (string, required, default: Subscription) — Indica o tipo do recurso transacionado.
- `status` (string, required) — **Obrigatório.** Na criação, tem de ser `requested`. Para desligar uma assinatura, envie `off`. A leitura devolve também `active`, depois do aperto de mão, e `error`, quando ele falhou.
- `criteria` (string, required) — **Obrigatório.** O tipo de recurso a observar — `Patient`, `Encounter` —, opcionalmente com parâmetros de busca depois de `?`. O tipo tem de ser um recurso FHIR válido.
- `reason` (string, required) — **Obrigatório pelo FHIR**, e sem efeito na plataforma: o texto é seu. Depois da primeira mudança de situação da assinatura, a leitura passa a devolver `-`.
- `channel` (Subscription_Channel, required) — **Obrigatório.** Para onde a notificação vai.
- `id` (string, optional) — Só resposta: identificador Nilo FHIR da assinatura.
- `meta` (Subscription_Meta, optional) — Traz, em `tag[0].code`, o identificador da assinatura na plataforma. Este recurso não tem `identifier`, e é por essa etiqueta que ele é reencontrado.
- `contact` (list of ContactPoint, optional) — Contatos para avisos sobre a assinatura. Só `system: email` é aceito, e o endereço é validado.
- `end` (string, optional) — Só resposta: preenchido quando a assinatura é desligada.
- `error` (string, optional) — Só resposta: o erro que derrubou o aperto de mão, quando o `status` é `error`.

## Errors

### 400 Bad Request Error

Rejeitado. O corpo é um `OperationOutcome` com `code: exception`, sem `expression`, e com a mensagem embrulhada — procure por substring, não por igualdade.

- `issue` (list of OperationOutcomeIssueItems, required) — Uma coleção de mensagens de erro, aviso ou informação que resultado de uma ação do sistema.
- `resourceType` (string, required, default: OperationOutcome) — Indica o tipo do recurso transacionado.

## Types

### Subscription_Channel

O canal de entrega da notificação.

- `type` (string, required) — **Só `rest-hook` é suportado.** Qualquer outro valor recusa a chamada.
- `endpoint` (string, required) — **Obrigatório.** A URL que a Nilo vai chamar. Precisa responder ao aperto de mão para a assinatura ficar ativa.
- `header` (list of string, optional) — Cabeçalhos extras, no formato `Nome: valor`, repassados em toda entrega. Um cabeçalho chamado `secret` define a chave usada para assinar as notificações — **mande sempre um**: sem ele, a Nilo gera uma chave que você não consegue ler.
- `payload` (string, optional) — Aceito e ignorado — a notificação vem sempre em `application/fhir+json`.

### Subscription_Meta

Metadados da assinatura. A etiqueta em `tag[0]` carrega o identificador dela, porque o `Subscription` do FHIR R4 não tem campo `identifier`.

- `versionId` (string, optional) — Versão do recurso no store.
- `lastUpdated` (string, optional) — Data da última alteração.
- `tag` (list of Coding, optional) — Um único item, com o identificador da assinatura em `code`.

### ContactPoint

Detalhes para todos os tipos de pontos de contato mediados por tecnologia para uma pessoa ou organização, incluindo telefone, e-mail, etc.

- `system` (enum, optional) — Meio tecnológico de contato.
  - Allowed values: `phone`, `fax`, `email`, `pager`, `url`, `sms`, `other`
- `use` (enum, optional) — Identifica a finalidade do ponto de contato.
  - Allowed values: `home`, `work`, `temp`, `old`, `mobile`
- `value` (string, optional) — Os detalhes reais do ponto de contato.

### OperationOutcomeIssueItems

Uma mensagem de erro, aviso ou informação que resultado de uma ação do sistema.

- `code` (enum, optional) — Descreve o tipo do problema.
  - Allowed values: `invalid`, `structure`, `required`, `value`, `invariant`, `security`, `login`, `unknown`, `expired`, `forbidden`, `suppressed`, `processing`, `not-supported`, `duplicate`, `multiple-matches`, `not-found`, `deleted`, `too-long`, `code-invalid`, `extension`, `too-costly`, `business-rule`, `conflict`, `transient`, `lock-error`, `no-store`, `exception`, `timeout`, `incomplete`, `throttled`, `informational`
- `details` (CodeableConcept, optional) — Detalhes adicionais sobre os códigos de resultado da operação de erro.
- `diagnostics` (string, optional) — Informações de diagnóstico adicionais sobre o problema
- `expression` (list of string, optional) — FHIR Path (caminho) do(s) elemento(s) relacionado(s) ao problema.
- `severity` (enum, optional) — Indica o resultado do processamento apesar do problema indicado.
  - Allowed values: `fatal`, `error`, `warning`, `information`

### Coding

Código definido por um sistema de terminologia.

- `code` (string, optional) — Código de identificação de um termo no sistema terminológico.
- `display` (string, optional) — Representação textual definida pelo sistema terminológico.
- `system` (string, optional) — Identidade do sistema terminológico.

### CodeableConcept

Um CodeableConcept representa um valor geralmente fornecido como uma referência a terminologias ou ontologias, mas também pode ser definido pelo fornecimento de texto. Esse é um padrão comum em dados de saúde.

- `coding` (list of Coding, optional) — Código definido por um sistema de terminologia.
- `text` (string, optional) — Representação de texto simples do conceito.

## Examples

### Assinatura criada

**Response**

```json
{
  "resourceType": "Subscription",
  "status": "requested",
  "criteria": "Patient",
  "reason": "Sincronizar cadastro de pacientes",
  "channel": {
    "type": "rest-hook",
    "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir",
    "header": [
      "secret: 8f14e45fceea167a5a36dedd4bea2543"
    ]
  },
  "id": "db1704e5-8c93-4a26-b0f7-45e28a1c9b60",
  "meta": {
    "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw",
    "lastUpdated": "2026-08-11T12:20:03.771000Z",
    "tag": [
      {
        "code": "412",
        "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/landing-zone-api--fhir-webhook"
      }
    ]
  }
}
```

**SDK Code**

```python Assinatura criada
import requests

url = "https://landing-zone-api.nilo.services/fhir/resources/Subscription"

headers = {"x-api-key": "<apiKey>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript Assinatura criada
const url = 'https://landing-zone-api.nilo.services/fhir/resources/Subscription';
const options = {method: 'POST', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Assinatura criada
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://landing-zone-api.nilo.services/fhir/resources/Subscription"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Assinatura criada
require 'uri'
require 'net/http'

url = URI("https://landing-zone-api.nilo.services/fhir/resources/Subscription")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Assinatura criada
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://landing-zone-api.nilo.services/fhir/resources/Subscription")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Assinatura criada
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://landing-zone-api.nilo.services/fhir/resources/Subscription', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Assinatura criada
using RestSharp;

var client = new RestClient("https://landing-zone-api.nilo.services/fhir/resources/Subscription");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Assinatura criada
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://landing-zone-api.nilo.services/fhir/resources/Subscription")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Criar uma assinatura

**Request**

```json
{
  "resourceType": "Subscription",
  "status": "requested",
  "criteria": "Patient",
  "reason": "Sincronizar cadastro de pacientes",
  "channel": {
    "type": "rest-hook",
    "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir"
  }
}
```

**Response**

```json
{
  "resourceType": "Subscription",
  "status": "requested",
  "criteria": "Patient",
  "reason": "Sincronizar cadastro de pacientes",
  "channel": {
    "type": "rest-hook",
    "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir",
    "header": [
      "secret: 8f14e45fceea167a5a36dedd4bea2543"
    ]
  },
  "id": "db1704e5-8c93-4a26-b0f7-45e28a1c9b60",
  "meta": {
    "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw",
    "lastUpdated": "2026-08-11T12:20:03.771000Z",
    "tag": [
      {
        "code": "412",
        "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/landing-zone-api--fhir-webhook"
      }
    ]
  }
}
```

**SDK Code**

```python Criar uma assinatura
import requests

url = "https://landing-zone-api.nilo.services/fhir/resources/Subscription"

payload = {
    "resourceType": "Subscription",
    "status": "requested",
    "criteria": "Patient",
    "reason": "Sincronizar cadastro de pacientes",
    "channel": {
        "type": "rest-hook",
        "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir"
    }
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Criar uma assinatura
const url = 'https://landing-zone-api.nilo.services/fhir/resources/Subscription';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"resourceType":"Subscription","status":"requested","criteria":"Patient","reason":"Sincronizar cadastro de pacientes","channel":{"type":"rest-hook","endpoint":"https://webhooks.acmesaude.com.br/nilo/fhir"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Criar uma assinatura
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://landing-zone-api.nilo.services/fhir/resources/Subscription"

	payload := strings.NewReader("{\n  \"resourceType\": \"Subscription\",\n  \"status\": \"requested\",\n  \"criteria\": \"Patient\",\n  \"reason\": \"Sincronizar cadastro de pacientes\",\n  \"channel\": {\n    \"type\": \"rest-hook\",\n    \"endpoint\": \"https://webhooks.acmesaude.com.br/nilo/fhir\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Criar uma assinatura
require 'uri'
require 'net/http'

url = URI("https://landing-zone-api.nilo.services/fhir/resources/Subscription")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"resourceType\": \"Subscription\",\n  \"status\": \"requested\",\n  \"criteria\": \"Patient\",\n  \"reason\": \"Sincronizar cadastro de pacientes\",\n  \"channel\": {\n    \"type\": \"rest-hook\",\n    \"endpoint\": \"https://webhooks.acmesaude.com.br/nilo/fhir\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Criar uma assinatura
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://landing-zone-api.nilo.services/fhir/resources/Subscription")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"resourceType\": \"Subscription\",\n  \"status\": \"requested\",\n  \"criteria\": \"Patient\",\n  \"reason\": \"Sincronizar cadastro de pacientes\",\n  \"channel\": {\n    \"type\": \"rest-hook\",\n    \"endpoint\": \"https://webhooks.acmesaude.com.br/nilo/fhir\"\n  }\n}")
  .asString();
```

```php Criar uma assinatura
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://landing-zone-api.nilo.services/fhir/resources/Subscription', [
  'body' => '{
  "resourceType": "Subscription",
  "status": "requested",
  "criteria": "Patient",
  "reason": "Sincronizar cadastro de pacientes",
  "channel": {
    "type": "rest-hook",
    "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Criar uma assinatura
using RestSharp;

var client = new RestClient("https://landing-zone-api.nilo.services/fhir/resources/Subscription");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"resourceType\": \"Subscription\",\n  \"status\": \"requested\",\n  \"criteria\": \"Patient\",\n  \"reason\": \"Sincronizar cadastro de pacientes\",\n  \"channel\": {\n    \"type\": \"rest-hook\",\n    \"endpoint\": \"https://webhooks.acmesaude.com.br/nilo/fhir\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Criar uma assinatura
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "resourceType": "Subscription",
  "status": "requested",
  "criteria": "Patient",
  "reason": "Sincronizar cadastro de pacientes",
  "channel": [
    "type": "rest-hook",
    "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir"
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://landing-zone-api.nilo.services/fhir/resources/Subscription")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Criar com segredo próprio e contato

**Request**

```json
{
  "resourceType": "Subscription",
  "status": "requested",
  "criteria": "Encounter",
  "reason": "Sincronizar atendimentos",
  "channel": {
    "type": "rest-hook",
    "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir",
    "header": [
      "secret: 8f14e45fceea167a5a36dedd4bea2543",
      "X-Origem: nilo"
    ]
  },
  "contact": [
    {
      "system": "email",
      "value": "integracao@acmesaude.com.br"
    }
  ]
}
```

**Response**

```json
{
  "resourceType": "Subscription",
  "status": "requested",
  "criteria": "Patient",
  "reason": "Sincronizar cadastro de pacientes",
  "channel": {
    "type": "rest-hook",
    "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir",
    "header": [
      "secret: 8f14e45fceea167a5a36dedd4bea2543"
    ]
  },
  "id": "db1704e5-8c93-4a26-b0f7-45e28a1c9b60",
  "meta": {
    "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw",
    "lastUpdated": "2026-08-11T12:20:03.771000Z",
    "tag": [
      {
        "code": "412",
        "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/landing-zone-api--fhir-webhook"
      }
    ]
  }
}
```

**SDK Code**

```python Criar com segredo próprio e contato
import requests

url = "https://landing-zone-api.nilo.services/fhir/resources/Subscription"

payload = {
    "resourceType": "Subscription",
    "status": "requested",
    "criteria": "Encounter",
    "reason": "Sincronizar atendimentos",
    "channel": {
        "type": "rest-hook",
        "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir",
        "header": ["secret: 8f14e45fceea167a5a36dedd4bea2543", "X-Origem: nilo"]
    },
    "contact": [
        {
            "system": "email",
            "value": "integracao@acmesaude.com.br"
        }
    ]
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Criar com segredo próprio e contato
const url = 'https://landing-zone-api.nilo.services/fhir/resources/Subscription';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"resourceType":"Subscription","status":"requested","criteria":"Encounter","reason":"Sincronizar atendimentos","channel":{"type":"rest-hook","endpoint":"https://webhooks.acmesaude.com.br/nilo/fhir","header":["secret: 8f14e45fceea167a5a36dedd4bea2543","X-Origem: nilo"]},"contact":[{"system":"email","value":"integracao@acmesaude.com.br"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Criar com segredo próprio e contato
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://landing-zone-api.nilo.services/fhir/resources/Subscription"

	payload := strings.NewReader("{\n  \"resourceType\": \"Subscription\",\n  \"status\": \"requested\",\n  \"criteria\": \"Encounter\",\n  \"reason\": \"Sincronizar atendimentos\",\n  \"channel\": {\n    \"type\": \"rest-hook\",\n    \"endpoint\": \"https://webhooks.acmesaude.com.br/nilo/fhir\",\n    \"header\": [\n      \"secret: 8f14e45fceea167a5a36dedd4bea2543\",\n      \"X-Origem: nilo\"\n    ]\n  },\n  \"contact\": [\n    {\n      \"system\": \"email\",\n      \"value\": \"integracao@acmesaude.com.br\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Criar com segredo próprio e contato
require 'uri'
require 'net/http'

url = URI("https://landing-zone-api.nilo.services/fhir/resources/Subscription")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"resourceType\": \"Subscription\",\n  \"status\": \"requested\",\n  \"criteria\": \"Encounter\",\n  \"reason\": \"Sincronizar atendimentos\",\n  \"channel\": {\n    \"type\": \"rest-hook\",\n    \"endpoint\": \"https://webhooks.acmesaude.com.br/nilo/fhir\",\n    \"header\": [\n      \"secret: 8f14e45fceea167a5a36dedd4bea2543\",\n      \"X-Origem: nilo\"\n    ]\n  },\n  \"contact\": [\n    {\n      \"system\": \"email\",\n      \"value\": \"integracao@acmesaude.com.br\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java Criar com segredo próprio e contato
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://landing-zone-api.nilo.services/fhir/resources/Subscription")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"resourceType\": \"Subscription\",\n  \"status\": \"requested\",\n  \"criteria\": \"Encounter\",\n  \"reason\": \"Sincronizar atendimentos\",\n  \"channel\": {\n    \"type\": \"rest-hook\",\n    \"endpoint\": \"https://webhooks.acmesaude.com.br/nilo/fhir\",\n    \"header\": [\n      \"secret: 8f14e45fceea167a5a36dedd4bea2543\",\n      \"X-Origem: nilo\"\n    ]\n  },\n  \"contact\": [\n    {\n      \"system\": \"email\",\n      \"value\": \"integracao@acmesaude.com.br\"\n    }\n  ]\n}")
  .asString();
```

```php Criar com segredo próprio e contato
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://landing-zone-api.nilo.services/fhir/resources/Subscription', [
  'body' => '{
  "resourceType": "Subscription",
  "status": "requested",
  "criteria": "Encounter",
  "reason": "Sincronizar atendimentos",
  "channel": {
    "type": "rest-hook",
    "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir",
    "header": [
      "secret: 8f14e45fceea167a5a36dedd4bea2543",
      "X-Origem: nilo"
    ]
  },
  "contact": [
    {
      "system": "email",
      "value": "integracao@acmesaude.com.br"
    }
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Criar com segredo próprio e contato
using RestSharp;

var client = new RestClient("https://landing-zone-api.nilo.services/fhir/resources/Subscription");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"resourceType\": \"Subscription\",\n  \"status\": \"requested\",\n  \"criteria\": \"Encounter\",\n  \"reason\": \"Sincronizar atendimentos\",\n  \"channel\": {\n    \"type\": \"rest-hook\",\n    \"endpoint\": \"https://webhooks.acmesaude.com.br/nilo/fhir\",\n    \"header\": [\n      \"secret: 8f14e45fceea167a5a36dedd4bea2543\",\n      \"X-Origem: nilo\"\n    ]\n  },\n  \"contact\": [\n    {\n      \"system\": \"email\",\n      \"value\": \"integracao@acmesaude.com.br\"\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Criar com segredo próprio e contato
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "resourceType": "Subscription",
  "status": "requested",
  "criteria": "Encounter",
  "reason": "Sincronizar atendimentos",
  "channel": [
    "type": "rest-hook",
    "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir",
    "header": ["secret: 8f14e45fceea167a5a36dedd4bea2543", "X-Origem: nilo"]
  ],
  "contact": [
    [
      "system": "email",
      "value": "integracao@acmesaude.com.br"
    ]
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://landing-zone-api.nilo.services/fhir/resources/Subscription")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Desligar uma assinatura

**Request**

```json
{
  "resourceType": "Subscription",
  "status": "off",
  "criteria": "Patient",
  "reason": "Encerrando a integração de pacientes",
  "channel": {
    "type": "rest-hook",
    "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir"
  }
}
```

**Response**

```json
{
  "resourceType": "Subscription",
  "status": "requested",
  "criteria": "Patient",
  "reason": "Sincronizar cadastro de pacientes",
  "channel": {
    "type": "rest-hook",
    "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir",
    "header": [
      "secret: 8f14e45fceea167a5a36dedd4bea2543"
    ]
  },
  "id": "db1704e5-8c93-4a26-b0f7-45e28a1c9b60",
  "meta": {
    "versionId": "MTc4NjAyMTQ1MjkwNTAwMDM2Nw",
    "lastUpdated": "2026-08-11T12:20:03.771000Z",
    "tag": [
      {
        "code": "412",
        "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/landing-zone-api--fhir-webhook"
      }
    ]
  }
}
```

**SDK Code**

```python Desligar uma assinatura
import requests

url = "https://landing-zone-api.nilo.services/fhir/resources/Subscription"

payload = {
    "resourceType": "Subscription",
    "status": "off",
    "criteria": "Patient",
    "reason": "Encerrando a integração de pacientes",
    "channel": {
        "type": "rest-hook",
        "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir"
    }
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Desligar uma assinatura
const url = 'https://landing-zone-api.nilo.services/fhir/resources/Subscription';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"resourceType":"Subscription","status":"off","criteria":"Patient","reason":"Encerrando a integração de pacientes","channel":{"type":"rest-hook","endpoint":"https://webhooks.acmesaude.com.br/nilo/fhir"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Desligar uma assinatura
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://landing-zone-api.nilo.services/fhir/resources/Subscription"

	payload := strings.NewReader("{\n  \"resourceType\": \"Subscription\",\n  \"status\": \"off\",\n  \"criteria\": \"Patient\",\n  \"reason\": \"Encerrando a integração de pacientes\",\n  \"channel\": {\n    \"type\": \"rest-hook\",\n    \"endpoint\": \"https://webhooks.acmesaude.com.br/nilo/fhir\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Desligar uma assinatura
require 'uri'
require 'net/http'

url = URI("https://landing-zone-api.nilo.services/fhir/resources/Subscription")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"resourceType\": \"Subscription\",\n  \"status\": \"off\",\n  \"criteria\": \"Patient\",\n  \"reason\": \"Encerrando a integração de pacientes\",\n  \"channel\": {\n    \"type\": \"rest-hook\",\n    \"endpoint\": \"https://webhooks.acmesaude.com.br/nilo/fhir\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Desligar uma assinatura
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://landing-zone-api.nilo.services/fhir/resources/Subscription")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"resourceType\": \"Subscription\",\n  \"status\": \"off\",\n  \"criteria\": \"Patient\",\n  \"reason\": \"Encerrando a integração de pacientes\",\n  \"channel\": {\n    \"type\": \"rest-hook\",\n    \"endpoint\": \"https://webhooks.acmesaude.com.br/nilo/fhir\"\n  }\n}")
  .asString();
```

```php Desligar uma assinatura
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://landing-zone-api.nilo.services/fhir/resources/Subscription', [
  'body' => '{
  "resourceType": "Subscription",
  "status": "off",
  "criteria": "Patient",
  "reason": "Encerrando a integração de pacientes",
  "channel": {
    "type": "rest-hook",
    "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Desligar uma assinatura
using RestSharp;

var client = new RestClient("https://landing-zone-api.nilo.services/fhir/resources/Subscription");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"resourceType\": \"Subscription\",\n  \"status\": \"off\",\n  \"criteria\": \"Patient\",\n  \"reason\": \"Encerrando a integração de pacientes\",\n  \"channel\": {\n    \"type\": \"rest-hook\",\n    \"endpoint\": \"https://webhooks.acmesaude.com.br/nilo/fhir\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Desligar uma assinatura
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "resourceType": "Subscription",
  "status": "off",
  "criteria": "Patient",
  "reason": "Encerrando a integração de pacientes",
  "channel": [
    "type": "rest-hook",
    "endpoint": "https://webhooks.acmesaude.com.br/nilo/fhir"
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://landing-zone-api.nilo.services/fhir/resources/Subscription")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```